Changeset 56315 in webkit for trunk/JavaScriptCore/API

Timestamp:

Mar 21, 2010, 1:35:09 AM (15 years ago)

Author:

[email protected]

Message:

Documentation fix for previous patch.

Reviewed by Maciej Stachowiak.

• API/JSObjectRefPrivate.h:

File:

• trunk/JavaScriptCore/API/JSObjectRefPrivate.h (modified) (2 diffs)

trunk/JavaScriptCore/API/JSObjectRefPrivate.h

@@ -40 +40 @@
  @param propertyName A JSString containing the property's name.
  @param value A JSValue to use as the property's value.  This may be NULL.
- @result The default object class does not allocate storage for private data. Only objects created with a non-NULL JSClass can store private properties.  If this method is used on an object with a NULL JSClass it will return false.
+ @result true if object can store private data, otherwise false.
  @discussion This API allows you to store JS values directly an object in a way that will be ensure that they are kept alive without exposing them to JavaScript code and without introducing the reference cycles that may occur when using JSValueProtect.
+
+ The default object class does not allocate storage for private data. Only objects created with a non-NULL JSClass can store private properties.
  */
 JS_EXPORT bool JSObjectSetPrivateProperty(JSContextRef ctx, JSObjectRef object, JSStringRef propertyName, JSValueRef value);
@@ -61 +63 @@
  @param object The JSObject whose private property you want to delete.
  @param propertyName A JSString containing the property's name.
- @result The default object class does not allocate storage for private data. Only objects created with a non-NULL JSClass can store private properties.  If this method is used on an object with a NULL JSClass it will return false.
+ @result true if object can store private data, otherwise false.
+ @discussion The default object class does not allocate storage for private data. Only objects created with a non-NULL JSClass can store private data.
  */
 JS_EXPORT bool JSObjectDeletePrivateProperty(JSContextRef ctx, JSObjectRef object, JSStringRef propertyName);