DevTools: [Documentation] Add signature section for renderer

Source/devtools/front_end/documentation/DocumentationView.js

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 /**
  * @constructor
  * @extends {WebInspector.View}
  */
 WebInspector.DocumentationView = function()
 {
     WebInspector.View.call(this);
     this.element.classList.add("documentation-view");
     this.registerRequiredCSS("documentationView.css");
 }
 
 /**
  * @param {string} url
  * @param {string} searchItem
  */
 WebInspector.DocumentationView.showDocumentationURL = function(url, searchItem)
 {
     if (!WebInspector.DocumentationView._view)
         WebInspector.DocumentationView._view = new WebInspector.DocumentationView();
     var view = WebInspector.DocumentationView._view;
+    view.element.removeChildren();

[lushnikov, 2014/09/04 12:51:37]

this looks like a left-over from a rebaseline, it shouldn't be needed (we
removechildren somewhere deeper in view.showDocumentation)

[semeny, 2014/09/04 16:17:20]

Done.

     WebInspector.inspectorView.showCloseableViewInDrawer("documentation", WebInspector.UIString("Documentation"), view);
     view.showDocumentation(url, searchItem);
 }
 
 WebInspector.DocumentationView.prototype = {
     /**
      * @param {string} url
      * @param {string} searchItem
      */
     showDocumentation: function(url, searchItem)
@@ skipping 62 matching lines @@
     {
         this._createPageTitle(this._article.pageTitle, this._searchItem);
         this._createStandardizationStatus(this._article.standardizationStatus);
         this._createTextSectionWithTitle("Summary", this._article.summary);
         this._createSignatureSection(this._article.parameters, this._article.methods);
         this._createReturnValueSection(this._article.methods);
         this._createExamplesSection(this._article.examples);
         this._createTextSectionWithTitle("Remarks", this._article.remarks);
 
         return this._element;
+
+        /**
+         * @param {string} name
+         * @return {boolean}
+         */
+         function isMethod(name)

[lushnikov, 2014/09/04 12:51:37]

where do you use this method?

[lushnikov, 2014/09/04 12:51:37]

wrong indent (9 chars?)

[semeny, 2014/09/04 16:17:20]

Done.

+         {
+             var tokens = name.split(".");
+             var currentObject = window;
+             for (var i = 0; i < tokens.length; i++) {

[lushnikov, 2014/09/04 12:51:37]

++i

[semeny, 2014/09/04 16:17:20]

Done.

+                currentObject = currentObject[tokens[i]];
+                if (!currentObject)
+                    return false;
+             }
+             return (typeof(currentObject) === "function");

[lushnikov, 2014/09/04 12:51:37]

typeof is operator - no need for brackets

[semeny, 2014/09/04 16:17:20]

Done.

+         }
     },
 
     /**
      * @param {string} titleText
      * @param {string} searchItem
      */
     _createPageTitle: function(titleText, searchItem)
     {
         var pageTitle = this._element.createChild("div", "documentation-page-title");
         if (titleText)
@@ skipping 168 matching lines @@
     appendApplicableItems: function(event, contextMenu, target)
     {
         if (!(target instanceof WebInspector.CodeMirrorTextEditor))
             return;
         var textEditor = /** @type {!WebInspector.CodeMirrorTextEditor} */ (target);
         var descriptors = this._determineDescriptors(textEditor);
         if (!descriptors.length)
             return;
         if (descriptors.length === 1) {
             var formatString = WebInspector.useLowerCaseMenuTitles() ? "Show documentation for %s.%s" : "Show Documentation for %s.%s";
-            contextMenu.appendItem(WebInspector.UIString(formatString, descriptors[0].name(), descriptors[0].searchItem()), WebInspector.DocumentationView.showDocumentationURL.bind(null, descriptors[0].url(), descriptors[0].searchItem()));
+            var methodName = String.sprintf("%s.%s", descriptors[0].name(), descriptors[0].searchItem());
+            contextMenu.appendItem(WebInspector.UIString(formatString, descriptors[0].name(), descriptors[0].searchItem()), WebInspector.DocumentationView.showDocumentationURL.bind(null, descriptors[0].url(), methodName));
             return;
         }
         var subMenuItem = contextMenu.appendSubMenuItem(WebInspector.UIString(WebInspector.useLowerCaseMenuTitles() ? "Show documentation for..." : "Show Documentation for..."));
-        for (var i = 0; i < descriptors.length; ++i)
-            subMenuItem.appendItem(String.sprintf("%s.%s", descriptors[i].name(), descriptors[i].searchItem()), WebInspector.DocumentationView.showDocumentationURL.bind(null, descriptors[i].url(), descriptors[i].searchItem()));
+        for (var i = 0; i < descriptors.length; ++i) {
+            var methodName = String.sprintf("%s.%s", descriptors[i].name(), descriptors[i].searchItem());
+            subMenuItem.appendItem(methodName, WebInspector.DocumentationView.showDocumentationURL.bind(null, descriptors[i].url(), methodName));
+        }
     },
 
     /**
      * @param {!WebInspector.CodeMirrorTextEditor} textEditor
      * @return {!Array.<!WebInspector.DocumentationURLProvider.ItemDescriptor>}
      */
     _determineDescriptors: function(textEditor)
     {
         var urlProvider = WebInspector.DocumentationURLProvider.instance();
         var textSelection = textEditor.selection().normalize();
@@ skipping 17 matching lines @@
         function computeDescriptors(column)
         {
             var token = textEditor.tokenAtTextPosition(textSelection.startLine, column);
             if (!token)
                 return [];
             var tokenText = textEditor.line(textSelection.startLine).substring(token.startColumn, token.endColumn);
             return urlProvider.itemDescriptors(tokenText);
         }
     }
 }