Changeset 95282 in webkit

Timestamp:

Sep 16, 2011 2:29:14 AM (13 years ago)

Author:

pfeldman@chromium.org

Message:

Web Inspector: rename Console.clearConsoleMessages to Console.clearMessages, brush up console domain doc.
​https://bugs.webkit.org/show_bug.cgi?id=68165

Reviewed by Yury Semikhatsky.

Source/WebCore:

• inspector/InjectedScriptHost.cpp:

(WebCore::InjectedScriptHost::clearConsoleMessages):

• inspector/Inspector.json:
• inspector/InspectorConsoleAgent.cpp:

(WebCore::InspectorConsoleAgent::clearMessages):

• inspector/InspectorConsoleAgent.h:
• inspector/front-end/ConsoleModel.js:

(WebInspector.ConsoleModel.prototype.requestClearMessages):

LayoutTests:

• inspector/protocol/console-agent-expected.txt:
• inspector/protocol/console-agent.html:

Location:

trunk

Files:

• LayoutTests/ChangeLog (modified) (1 diff)
• LayoutTests/inspector/protocol/console-agent-expected.txt (modified) (2 diffs)
• LayoutTests/inspector/protocol/console-agent.html (modified) (1 diff)
• Source/WebCore/ChangeLog (modified) (1 diff)
• Source/WebCore/inspector/InjectedScriptHost.cpp (modified) (1 diff)
• Source/WebCore/inspector/Inspector.json (modified) (10 diffs)
• Source/WebCore/inspector/InspectorConsoleAgent.cpp (modified) (2 diffs)
• Source/WebCore/inspector/InspectorConsoleAgent.h (modified) (1 diff)
• Source/WebCore/inspector/front-end/ConsoleModel.js (modified) (1 diff)

trunk/LayoutTests/ChangeLog

@@ +1 @@
+2011-09-15  Pavel Feldman  <pfeldman@google.com>
+
+        Web Inspector: rename Console.clearConsoleMessages to Console.clearMessages, brush up console domain doc.
+        https://bugs.webkit.org/show_bug.cgi?id=68165
+
+        Reviewed by Yury Semikhatsky.
+
+        * inspector/protocol/console-agent-expected.txt:
+        * inspector/protocol/console-agent.html:
+
 2011-09-16  Keishi Hattori  <keishi@webkit.org>
 

trunk/LayoutTests/inspector/protocol/console-agent-expected.txt

@@ -92 +92 @@
 
 -----------------------------------------------------------
-ConsoleAgent.clearConsoleMessages()
+ConsoleAgent.clearMessages()
 
 request:
 {
-    method : "Console.clearConsoleMessages"
+    method : "Console.clearMessages"
     id : <number>
 }
@@ -174 +174 @@
     enable : "checked"
     disable : "checked"
-    clearConsoleMessages : "checked"
+    clearMessages : "checked"
     setMonitoringXHREnabled : "checked"
     addInspectedNode : "checked"

trunk/LayoutTests/inspector/protocol/console-agent.html

@@ -11 +11 @@
         ["ConsoleAgent", "enable"],
         ["RuntimeAgent", "evaluate", "console.info('test'); console.info('test')", "test-group", false],
-        ["ConsoleAgent", "clearConsoleMessages"],
+        ["ConsoleAgent", "clearMessages"],
         ["ConsoleAgent", "setMonitoringXHREnabled", true],
         ["ConsoleAgent", "setMonitoringXHREnabled", false],

trunk/Source/WebCore/ChangeLog

@@ +1 @@
+2011-09-15  Pavel Feldman  <pfeldman@google.com>
+
+        Web Inspector: rename Console.clearConsoleMessages to Console.clearMessages, brush up console domain doc.
+        https://bugs.webkit.org/show_bug.cgi?id=68165
+
+        Reviewed by Yury Semikhatsky.
+
+        * inspector/InjectedScriptHost.cpp:
+        (WebCore::InjectedScriptHost::clearConsoleMessages):
+        * inspector/Inspector.json:
+        * inspector/InspectorConsoleAgent.cpp:
+        (WebCore::InspectorConsoleAgent::clearMessages):
+        * inspector/InspectorConsoleAgent.h:
+        * inspector/front-end/ConsoleModel.js:
+        (WebInspector.ConsoleModel.prototype.requestClearMessages):
+
 2011-09-16  Alejandro G. Castro  <alex@igalia.com>
 

trunk/Source/WebCore/inspector/InjectedScriptHost.cpp

@@ -123 +123 @@
     if (m_consoleAgent) {
         ErrorString error;
-        m_consoleAgent->clearConsoleMessages(&error);
+        m_consoleAgent->clearMessages(&error);
     }
 }

trunk/Source/WebCore/inspector/Inspector.json

@@ -129 +129 @@
                 "name": "reload",
                 "parameters": [
-                    { "name": "ignoreCache", "type": "boolean", "optional": true }
+                    { "name": "ignoreCache", "type": "boolean", "optional": true, "description": "If true, browser cache is ignored (as if the user pressed Shift+refresh)." }
                 ],
                 "description": "Reloads given page optionally ignoring the cache."
@@ -333 +333 @@
     {
         "domain": "Console",
-        "description": "Console domain defines methods and events for interaction with the JavaScript console. One needs to enable this domain using <code>enable</code> function in order to start receiving the console messages.",
+        "description": "Console domain defines methods and events for interaction with the JavaScript console. Console collects messages created by means of the <a href='http://getfirebug.com/wiki/index.php/Console_API'>JavaScript Console API</a>. One needs to enable this domain using <code>enable</code> function in order to start receiving the console messages. Browser will collect messages issued while console domain is not enabled and will report them using <code>messageAdded</code> notification upon enabling.",
         "types": [
             {
@@ -343 +343 @@
                     { "name": "type", "type": "string", "enum": ["log", "other", "trace", "startGroup", "startGroupCollapsed", "endGroup", "assert", "uncaughtException", "networkError", "result"], "description": "Message type." },
                     { "name": "level", "type": "string", "enum": ["tip", "log", "warning", "error", "debug"], "description": "Message severity." },
-                    { "name": "line", "type": "integer", "description": "JavaScript source line that created console message." },
-                    { "name": "url", "type": "string", "description": "JavaScript source url that created console message." },
-                    { "name": "repeatCount", "type": "integer", "optional": true, "description": "Repeat count for repeated messages." },
+                    { "name": "line", "type": "integer", "description": "Line number in the message origin resource." },
+                    { "name": "url", "type": "string", "description": "URL of the message origin." },
+                    { "name": "repeatCount", "type": "integer", "description": "Repeat count for repeated messages." },
                     { "name": "text", "type": "string", "description": "Message text." },
-                    { "name": "networkRequestId", "$ref": "Network.RequestId", "optional": true, "description": "Identifier of the network request associated with the console message." },
+                    { "name": "networkRequestId", "$ref": "Network.RequestId", "optional": true, "description": "Identifier of the network request associated with this message." },
                     { "name": "parameters", "type": "array", "items": { "$ref": "Runtime.RemoteObject" }, "description": "Message parameters in case of the formatted message." },
-                    { "name": "stackTrace", "$ref": "StackTrace", "description": "Stack trace for assert and error messages." }
+                    { "name": "stackTrace", "$ref": "StackTrace", "description": "JavaScript stack trace for assertions and error messages." }
                 ]
             },
@@ -358 +358 @@
                 "properties": [
                     { "name": "functionName", "type": "string", "description": "JavaScript function name." },
-                    { "name": "url", "type": "string", "description": "JavaScript source name / url." },
-                    { "name": "lineNumber", "type": "string", "description": "JavaScript source line number." },
-                    { "name": "columnNumber", "type": "string", "description": "JavaScript source column number." }
+                    { "name": "url", "type": "string", "description": "JavaScript script name or url." },
+                    { "name": "lineNumber", "type": "string", "description": "JavaScript script line number." },
+                    { "name": "columnNumber", "type": "string", "description": "JavaScript script column number." }
                 ]
             },
@@ -367 +367 @@
                 "type": "array",
                 "items": { "$ref": "CallFrame" },
-                "description": "Call frames for assert and error messages."
+                "description": "Call frames for assertions or error messages."
             }
         ],
@@ -374 +374 @@
                 "name": "enable",
                 "returns": [
-                    { "name": "expiredMessagesCount", "type": "integer", "description": "Number of messages cleared due to message threashold overflow." }
-                ],
-                "description": "Enables console domain, sends all the messages collected so far to the client." 
+                    { "name": "expiredMessagesCount", "type": "integer", "description": "Number of messages collected due to message threashold overflow." }
+                ],
+                "description": "Enables console domain, sends the messages collected so far to the client by means of the <code>messageAdded</code> notification." 
             },
             {
@@ -383 +383 @@
             },
             {
-                "name": "clearConsoleMessages",
-                "description": "Clears collected console messages." 
+                "name": "clearMessages",
+                "description": "Clears console messages collected in the browser." 
             },
             {
@@ -391 +391 @@
                     { "name": "enabled", "type": "boolean", "description": "Monitoring enabled state." }
                 ],
-                "description": "Toggles monitoring of XMLHttpRequest. If <code>true</code>, console will receive messages upon each XHR issued." 
+                "description": "Toggles monitoring of XMLHttpRequest. If <code>true</code>, console will receive messages upon each XHR issued.", 
+                "hidden": true
             },
             {
@@ -408 +409 @@
                     { "name": "messageObj", "$ref": "ConsoleMessage", "description": "Console message that has been added." }
                 ],
-                "description": "Issued for each console message added."
+                "description": "Issued when new console message is added."
             },
             {
@@ -415 +416 @@
                     { "name": "count", "type": "integer", "description": "New repeat count value." }
                 ],
-                "description": "In case of subsequent message being equal to the previous one, only repeat count is being updated."
+                "description": "Issued when subsequent message(s) are equal to the previous one."
             },
             {

trunk/Source/WebCore/inspector/InspectorConsoleAgent.cpp

@@ -98 +98 @@
 }
 
-void InspectorConsoleAgent::clearConsoleMessages(ErrorString*)
+void InspectorConsoleAgent::clearMessages(ErrorString*)
 {
     m_consoleMessages.clear();
@@ -112 +112 @@
 {
     ErrorString error;
-    clearConsoleMessages(&error);
+    clearMessages(&error);
     m_times.clear();
     m_counts.clear();

trunk/Source/WebCore/inspector/InspectorConsoleAgent.h

@@ -62 +62 @@
     void enable(ErrorString*, int* consoleMessageExpireCount);
     void disable(ErrorString*);
-    void clearConsoleMessages(ErrorString* error);
+    void clearMessages(ErrorString*);
     void reset();
     void restore();

trunk/Source/WebCore/inspector/front-end/ConsoleModel.js

@@ -89 +89 @@
     requestClearMessages: function()
     {
-        ConsoleAgent.clearConsoleMessages();
+        ConsoleAgent.clearMessages();
         this.clearMessages();
     },