JavaScriptCore-7600.1.4.15.12.tar.gz

[apple/javascriptcore.git] / API / JSVirtualMachine.h

diff --git a/API/JSVirtualMachine.h b/API/JSVirtualMachine.h
index 2f7c53fb7311a9035acff0ac7ed6de9420476f7e..dc9becbab112a6087b86533b2ea19cc5f0e5ccf0 100644 (file)
--- a/API/JSVirtualMachine.h
+++ b/API/JSVirtualMachine.h
@@ -27,30 +27,58 @@
 
 #if JSC_OBJC_API_ENABLED
 
-// An instance of JSVirtualMachine represents a single JavaScript "object space"
-// or set of execution resources. Thread safety is supported by locking the
-// virtual machine, with concurrent JavaScript execution supported by allocating
-// separate instances of JSVirtualMachine.
-
+/*!
+@interface
+@discussion An instance of JSVirtualMachine represents a single JavaScript "object space"
+ or set of execution resources. Thread safety is supported by locking the
+ virtual machine, with concurrent JavaScript execution supported by allocating
+ separate instances of JSVirtualMachine.
+*/
+#ifndef JSC_OBJC_API_AVAILABLE_MAC_OS_X_1080
 NS_CLASS_AVAILABLE(10_9, 7_0)
+#else
+OBJC_VISIBLE
+#endif
 @interface JSVirtualMachine : NSObject
 
-// Create a new JSVirtualMachine.
-- (id)init;
-
-// addManagedReference:withOwner and removeManagedReference:withOwner allow 
-// clients of JSVirtualMachine to make the JavaScript runtime aware of 
-// arbitrary external Objective-C object graphs. The runtime can then use 
-// this information to retain any JavaScript values that are referenced 
-// from somewhere in said object graph.
-// 
-// For correct behavior clients must make their external object graphs 
-// reachable from within the JavaScript runtime. If an Objective-C object is 
-// reachable from within the JavaScript runtime, all managed references 
-// transitively reachable from it as recorded with 
-// addManagedReference:withOwner: will be scanned by the garbage collector.
-// 
+/*!
+@methodgroup Creating New Virtual Machines
+*/
+/*!
+@method
+@abstract Create a new JSVirtualMachine.
+*/
+- (instancetype)init;
+
+/*!
+@methodgroup Memory Management
+*/
+/*!
+@method
+@abstract Notify the JSVirtualMachine of an external object relationship.
+@discussion Allows clients of JSVirtualMachine to make the JavaScript runtime aware of 
+ arbitrary external Objective-C object graphs. The runtime can then use 
+ this information to retain any JavaScript values that are referenced 
+ from somewhere in said object graph.
+
+ For correct behavior clients must make their external object graphs 
+ reachable from within the JavaScript runtime. If an Objective-C object is 
+ reachable from within the JavaScript runtime, all managed references 
+ transitively reachable from it as recorded using
+ -addManagedReference:withOwner: will be scanned by the garbage collector.
+@param object The object that the owner points to.
+@param owner The object that owns the pointed to object.
+*/ 
 - (void)addManagedReference:(id)object withOwner:(id)owner;
+
+/*!
+@method
+@abstract Notify the JSVirtualMachine that a previous object relationship no longer exists.
+@discussion The JavaScript runtime will continue to scan any references that were
+ reported to it by -addManagedReference:withOwner: until those references are removed.
+@param object The object that was formerly owned.
+@param owner The former owner.
+*/
 - (void)removeManagedReference:(id)object withOwner:(id)owner;
 
 @end