Web Inspector: rename Console.clearConsoleMessages to Console.clearMessages, brush...
authorpfeldman@chromium.org <pfeldman@chromium.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Fri, 16 Sep 2011 09:29:14 +0000 (09:29 +0000)
committerpfeldman@chromium.org <pfeldman@chromium.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Fri, 16 Sep 2011 09:29:14 +0000 (09:29 +0000)
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:

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

LayoutTests/ChangeLog
LayoutTests/inspector/protocol/console-agent-expected.txt
LayoutTests/inspector/protocol/console-agent.html
Source/WebCore/ChangeLog
Source/WebCore/inspector/InjectedScriptHost.cpp
Source/WebCore/inspector/Inspector.json
Source/WebCore/inspector/InspectorConsoleAgent.cpp
Source/WebCore/inspector/InspectorConsoleAgent.h
Source/WebCore/inspector/front-end/ConsoleModel.js

index 7632fdf..92ae48d 100644 (file)
@@ -1,3 +1,13 @@
+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>
 
         [chromium] Rebaselines due to r95203 and r95207.
index 9b3006e..e03cce2 100644 (file)
@@ -91,11 +91,11 @@ response:
 }
 
 -----------------------------------------------------------
-ConsoleAgent.clearConsoleMessages()
+ConsoleAgent.clearMessages()
 
 request:
 {
-    method : "Console.clearConsoleMessages"
+    method : "Console.clearMessages"
     id : <number>
 }
 
@@ -173,7 +173,7 @@ Coverage for ConsoleAgent
 {
     enable : "checked"
     disable : "checked"
-    clearConsoleMessages : "checked"
+    clearMessages : "checked"
     setMonitoringXHREnabled : "checked"
     addInspectedNode : "checked"
     messageAdded : "checked"
index da1e31d..41e7ded 100644 (file)
@@ -10,7 +10,7 @@ function test()
         ["ConsoleAgent", "disable"],
         ["ConsoleAgent", "enable"],
         ["RuntimeAgent", "evaluate", "console.info('test'); console.info('test')", "test-group", false],
-        ["ConsoleAgent", "clearConsoleMessages"],
+        ["ConsoleAgent", "clearMessages"],
         ["ConsoleAgent", "setMonitoringXHREnabled", true],
         ["ConsoleAgent", "setMonitoringXHREnabled", false],
         ["ConsoleAgent", "addInspectedNode", 1]
index d5bdd00..f604a74 100644 (file)
@@ -1,3 +1,19 @@
+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>
 
         Fix GTK build after r95245.
index e711446..6657834 100644 (file)
@@ -122,7 +122,7 @@ void InjectedScriptHost::clearConsoleMessages()
 {
     if (m_consoleAgent) {
         ErrorString error;
-        m_consoleAgent->clearConsoleMessages(&error);
+        m_consoleAgent->clearMessages(&error);
     }
 }
 
index eae254c..a937751 100644 (file)
             {
                 "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."
             },
     },
     {
         "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": [
             {
                 "id": "ConsoleMessage",
                     { "name": "source", "type": "string", "enum": ["html", "wml", "xml", "javascript", "css", "other"], "description": "Message source." },
                     { "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." }
                 ]
             },
             {
                 "description": "Stack entry for console errors and assertions.",
                 "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." }
                 ]
             },
             {
                 "id": "StackTrace",
                 "type": "array",
                 "items": { "$ref": "CallFrame" },
-                "description": "Call frames for assert and error messages."
+                "description": "Call frames for assertions or error messages."
             }
         ],
         "commands": [
             {
                 "name": "enable",
                 "returns": [
-                    { "name": "expiredMessagesCount", "type": "integer", "description": "Number of messages cleared due to message threashold overflow." }
+                    { "name": "expiredMessagesCount", "type": "integer", "description": "Number of messages collected due to message threashold overflow." }
                 ],
-                "description": "Enables console domain, sends all the messages collected so far to the client." 
+                "description": "Enables console domain, sends the messages collected so far to the client by means of the <code>messageAdded</code> notification." 
             },
             {
                 "name": "disable",
                 "description": "Disables console domain, prevents further console messages from being sent to the client." 
             },
             {
-                "name": "clearConsoleMessages",
-                "description": "Clears collected console messages." 
+                "name": "clearMessages",
+                "description": "Clears console messages collected in the browser." 
             },
             {
                 "name": "setMonitoringXHREnabled",
                 "parameters": [
                     { "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
             },
             {
                 "name": "addInspectedNode",
                 "parameters": [
                     { "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."
             },
             {
                 "name": "messageRepeatCountUpdated",
                 "parameters": [
                     { "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."
             },
             {
                 "name": "messagesCleared",
index a3f2c23..d6b3268 100644 (file)
@@ -97,7 +97,7 @@ void InspectorConsoleAgent::disable(ErrorString*)
     m_inspectorState->setBoolean(ConsoleAgentState::consoleMessagesEnabled, false);
 }
 
-void InspectorConsoleAgent::clearConsoleMessages(ErrorString*)
+void InspectorConsoleAgent::clearMessages(ErrorString*)
 {
     m_consoleMessages.clear();
     m_expiredConsoleMessageCount = 0;
@@ -111,7 +111,7 @@ void InspectorConsoleAgent::clearConsoleMessages(ErrorString*)
 void InspectorConsoleAgent::reset()
 {
     ErrorString error;
-    clearConsoleMessages(&error);
+    clearMessages(&error);
     m_times.clear();
     m_counts.clear();
 }
index 839f950..2576a74 100644 (file)
@@ -61,7 +61,7 @@ public:
 
     void enable(ErrorString*, int* consoleMessageExpireCount);
     void disable(ErrorString*);
-    void clearConsoleMessages(ErrorString* error);
+    void clearMessages(ErrorString*);
     void reset();
     void restore();
     void setFrontend(InspectorFrontend*);
index 9e21f2c..0783a7d 100644 (file)
@@ -88,7 +88,7 @@ WebInspector.ConsoleModel.prototype = {
 
     requestClearMessages: function()
     {
-        ConsoleAgent.clearConsoleMessages();
+        ConsoleAgent.clearMessages();
         this.clearMessages();
     },