[Chromium] Improve the comment describing mainWorldScriptContext
authorabarth@webkit.org <abarth@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Thu, 11 Oct 2012 21:13:09 +0000 (21:13 +0000)
committerabarth@webkit.org <abarth@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Thu, 11 Oct 2012 21:13:09 +0000 (21:13 +0000)
https://bugs.webkit.org/show_bug.cgi?id=99092

Reviewed by James Robinson.

* public/WebFrame.h:
(WebFrame):
    - Add some more text about what this API does so that folks who
      call it know what they need to worry about.

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@131095 268f45cc-cd09-0410-ab3c-d52691b4dbfc

Source/WebKit/chromium/ChangeLog
Source/WebKit/chromium/public/WebFrame.h

index f2f6a17..803f023 100644 (file)
@@ -1,3 +1,15 @@
+2012-10-11  Adam Barth  <abarth@webkit.org>
+
+        [Chromium] Improve the comment describing mainWorldScriptContext
+        https://bugs.webkit.org/show_bug.cgi?id=99092
+
+        Reviewed by James Robinson.
+
+        * public/WebFrame.h:
+        (WebFrame):
+            - Add some more text about what this API does so that folks who
+              call it know what they need to worry about.
+
 2012-10-11  Sheriff Bot  <webkit.review.bot@gmail.com>
 
         Unreviewed.  Rolled DEPS.
index c73ffa6..b2c88ec 100644 (file)
@@ -294,8 +294,11 @@ public:
         int argc,
         v8::Handle<v8::Value> argv[]) = 0;
 
-    // Returns the V8 context for this frame, or an empty handle if there
-    // is none.
+    // Returns the V8 context for associated with the main world and this
+    // frame. There can be many V8 contexts associated with this frame, one for
+    // each isolated world and one for the main world. If you don't know what
+    // the "main world" or an "isolated world" is, then you probably shouldn't
+    // be calling this API.
     virtual v8::Local<v8::Context> mainWorldScriptContext() const = 0;
 
     // Creates an instance of file system object.