[Webkit-unassigned] [Bug 37017] New: Improvement to comments in JavaScriptCore header files

[bugzilla-daemon at webkit.org]

https://bugs.webkit.org/show_bug.cgi?id=37017

           Summary: Improvement to comments in JavaScriptCore header files
           Product: WebKit
           Version: 528+ (Nightly build)
          Platform: All
        OS/Version: All
            Status: UNCONFIRMED
          Severity: Enhancement
          Priority: P2
         Component: JavaScriptCore
        AssignedTo: webkit-unassigned at lists.webkit.org
        ReportedBy: demallien at me.com


In the comments describing the functionality of the JSStringRef and JSClassRef
CreateXxxx functions, the following comment is used to describe the memory
management of the types created "Ownership follows the Create Rule".  However,
for people not coming from an Objective-C background, it is not clear what the
Create Rule actually is - Googling for this term does not give a good response
on the first page.

I propose changing the comment to "Ownership follows the CoreFoundation Create
Rule", which, when used as a Google search term, gives the necessary page as
the first response.

A related problem, there is no comment at all for memory management of
JSContextRefs - I assume that they are handled the same way as JSStringRefs and
JSClassRefs, but it would be helpful to have the same comment added to Create
functions of JSContextRef

-- 
Configure bugmail: https://bugs.webkit.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.