Bug 37017 - Improvement to comments in JavaScriptCore header files
Summary: Improvement to comments in JavaScriptCore header files
Status: NEW
Alias: None
Product: WebKit
Classification: Unclassified
Component: JavaScriptCore (show other bugs)
Version: 528+ (Nightly build)
Hardware: All All
: P2 Enhancement
Assignee: Nobody
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2010-04-02 00:54 PDT by Allison Newman
Modified: 2010-04-02 16:18 PDT (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Allison Newman 2010-04-02 00:54:23 PDT
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