Update comment in the API to explicitly state that the handle returned

from Context::New is persistent and has to be disposed at some point
in order to allow garbage collecting the context.

Review URL: http://codereview.chromium.org/2220003

git-svn-id: http://v8.googlecode.com/svn/branches/bleeding_edge@4727 ce2b1a6d-e550-0410-aec6-3dcde31c8c00

diff --git a/include/v8.h b/include/v8.h
index b7f1d35..5b5dabe 100644 (file)
--- a/include/v8.h
+++ b/include/v8.h
@@ -2901,7 +2901,12 @@ class V8EXPORT Context {
    */
   void ReattachGlobal(Handle<Object> global_object);
 
-  /** Creates a new context. */
+  /** Creates a new context.
+   *
+   * Returns a persistent handle to the newly allocated context. This
+   * persistent handle has to be disposed when the context is no
+   * longer used so the context can be garbage collected.
+   */
   static Persistent<Context> New(
       ExtensionConfiguration* extensions = NULL,
       Handle<ObjectTemplate> global_template = Handle<ObjectTemplate>(),