Changeset 140197 in webkit

Timestamp:

Jan 18, 2013 12:54:34 PM (11 years ago)

Author:

mhahnenberg@apple.com

Message:

Objective-C API: Update documentation for JSValue and JSContext
​https://bugs.webkit.org/show_bug.cgi?id=107313

Reviewed by Geoffrey Garen.

After changing the semantics of object lifetime we need to update the API documentation to reflect the new semantics.

• API/APIJSValue.h:
• API/JSContext.h:

Location:

trunk/Source/JavaScriptCore

Files:

• API/APIJSValue.h (modified) (1 diff)
• API/JSContext.h (modified) (1 diff)
• ChangeLog (modified) (1 diff)

trunk/Source/JavaScriptCore/API/APIJSValue.h

@@ -29 +29 @@
 
 // A JSValue is a reference to a value within the JavaScript object space of a
-// JSVirtualMachine. All instances of JSValue originate from a JSContext, and
-// hold a strong reference to this JSContext. Where an instance method is invoked
-// upon a JSValue, and this returns another JSValue, the returned JSValue will
-// originate from the same JSContext as the JSValue on which the method was
-// invoked.
-//
-// The JSContext is used to manage the life-cycle of the referenced JavaScript
-// value within the virtual machine. So long as the JSContext is being retained
-// the JSValue will continue to keep the referenced value within the JavaScript
-// virtual machine alive. When the JSContext associated with a JSValue is
-// deallocated the weak context property of the JSValue will become nil. After
-// this occurs the value within the JavaScript virtual machine is no longer
-// being maintained by this JSValue, and the JSValue instance may no longer by
-// used as a reference to this value. For any method invoked on instance of
-// JSValue with a nil context, the method will return a nil/zero/false result.
+// JSVirtualMachine. All instances of JSValue originate from a JSContext and
+// hold a strong reference to this JSContext. As long as any value associated with 
+// a particular JSContext is retained, that JSContext will remain alive. 
+// Where an instance method is invoked upon a JSValue, and this returns another 
+// JSValue, the returned JSValue will originate from the same JSContext as the 
+// JSValue on which the method was invoked.
 //
 // For all methods taking arguments of type id, arguments will be converted

trunk/Source/JavaScriptCore/API/JSContext.h

@@ -34 +34 @@
 // JSContext is also used to manage the life-cycle of objects within the
 // JavaScript virtual machine. Every instance of JSValue is associated with a
-// JSContext via a weak reference. The JSValue will keep the JavaScript value it
-// references alive so long as the JSContext is also retained. When an instance
-// of JSContext is deallocated and the weak references to it are cleared the
-// JSValues that had been associated with this context will be invalidated, and
-// will cease to keep the values within the JavaScript engine alive.
+// JSContext via a strong reference. The JSValue will keep the JSContext it
+// references alive so long as the JSValue remains alive. When all of the JSValues
+// that reference a particular JSContext have been deallocated the JSContext 
+// will be deallocated unless it has been previously retained.
 
 NS_CLASS_AVAILABLE(10_9, NA)

trunk/Source/JavaScriptCore/ChangeLog

@@ +1 @@
+2013-01-18  Mark Hahnenberg  <mhahnenberg@apple.com>
+
+        Objective-C API: Update documentation for JSValue and JSContext
+        https://bugs.webkit.org/show_bug.cgi?id=107313
+
+        Reviewed by Geoffrey Garen.
+
+        After changing the semantics of object lifetime we need to update the API documentation to reflect the new semantics.
+
+        * API/APIJSValue.h:
+        * API/JSContext.h:
+
 2013-01-18  Balazs Kilvady  <kilvadyb@homejinni.com>