Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1587)

Unified Diff: Source/devtools/front_end/documentation/DocumentationView.js

Issue 525363003: DevTools: [Documentation] Add signature section for renderer (Closed) Base URL: https://chromium.googlesource.com/chromium/blink.git@iliia-patch
Patch Set: Change signature css-class selector Created 6 years, 3 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: Source/devtools/front_end/documentation/DocumentationView.js
diff --git a/Source/devtools/front_end/documentation/DocumentationView.js b/Source/devtools/front_end/documentation/DocumentationView.js
index 042f0a243dfb3d91978eae87abf3857b071e2a0b..36f8ea8874675db94edd61c4688e5694ae60449e 100644
--- a/Source/devtools/front_end/documentation/DocumentationView.js
+++ b/Source/devtools/front_end/documentation/DocumentationView.js
@@ -102,8 +102,9 @@ WebInspector.DocumentationView.Renderer.prototype = {
{
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._createTextSectionWithTitle("Summary", this._article.summary);
+ this._createParametersSection(this._article.parameters);
this._createReturnValueSection(this._article.methods);
this._createExamplesSection(this._article.examples);
this._createTextSectionWithTitle("Remarks", this._article.remarks);
@@ -148,6 +149,7 @@ WebInspector.DocumentationView.Renderer.prototype = {
title.textContent = titleText;
var text = this._renderBlock(article);
text.classList.add("documentation-text");
+ text.classList.add("documentation-section-content");
section.appendChild(text);
},
@@ -157,20 +159,42 @@ WebInspector.DocumentationView.Renderer.prototype = {
*/
_createSignatureSection: function(parameters, method)
{
+ if (!method)
+ return;
+ var section = this._element.createChild("p", "documentation-section");
+ var signature = section.createChild("span", "documentation-method-signature documentation-section-content monospace");
+ var methodName = signature.createChild("span", "documentation-method-name");
+ methodName.textContent = this._searchItem.split(".").peekLast() + "(";
+ for (var i = 0; i < parameters.length; ++i) {
+ if (i > 0)
+ signature.createTextChild(", ")
+ var parameterType = signature.createChild("span", "documentation-parameter-data-type-value");
+ parameterType.textContent = parameters[i].dataType + (parameters[i].optional ? "=" : "");;
+ }
+ signature.createTextChild("): ");
+ var returnTypeElement = signature.createChild("span", "documentation-parameter-data-type-value");
+ returnTypeElement.textContent = method.returnValueName;
+ },
+
+ /**
+ * @param {!Array.<!WebInspector.JSArticle.Parameter>} parameters
+ */
+ _createParametersSection: function(parameters)
+ {
if (!parameters.length)
return;
var section = this._element.createChild("div", "documentation-section");
var title = section.createChild("div", "documentation-section-title");
title.textContent = "Parameters";
for (var i = 0; i < parameters.length; ++i) {
- var parameter = section.createChild("div", "documentation-parameter");
+ var parameter = section.createChild("div", "documentation-parameter documentation-section-content");
var header = parameter.createChild("div", "documentation-parameter-header");
var name = header.createChild("span", "documentation-parameter-name");
name.textContent = parameters[i].name;
- var dataTypeValue = header.createChild("span", "documentation-parameter-data-type-value");
+ var dataTypeValue = header.createChild("span", "documentation-parameter-data-type-value documentation-parameter-margin");
dataTypeValue.textContent = parameters[i].dataType;
if (parameters[i].optional) {
- var optional = header.createChild("span", "documentation-parameter-optional");
+ var optional = header.createChild("span", "documentation-parameter-optional documentation-parameter-margin");
optional.textContent = WebInspector.UIString("Optional");
}
parameter.appendChild(this._renderBlock(parameters[i].description));
@@ -184,13 +208,12 @@ WebInspector.DocumentationView.Renderer.prototype = {
{
if (!method)
return;
-
var section = this._element.createChild("div", "documentation-section");
var title = section.createChild("div", "documentation-section-title");
title.textContent = "Return Value";
- var returnValueName = section.createChild("div", "documentation-return-value");
+ var returnValueName = section.createChild("div", "documentation-section-content documentation-return-value");
returnValueName.textContent = WebInspector.UIString("Returns an object of type " + method.returnValueName + ".");
- var returnValueDescription = section.createChild("div", "documentation-return-value");
+ var returnValueDescription = section.createChild("div", "documentation-section-content documentation-text");
returnValueDescription.textContent = WebInspector.UIString(method.returnValueDescription);
},
@@ -207,16 +230,17 @@ WebInspector.DocumentationView.Renderer.prototype = {
title.textContent = "Examples";
for (var i = 0; i < examples.length; ++i) {
- var example = section.createChild("div", "documentation-example");
+ var example = section.createChild("div", "documentation-example documentation-section-content");
var exampleDescription = example.createChild("div", "documentation-example-description-section");
if (examples[i].liveUrl) {
var liveUrl = exampleDescription.createChild("a", "documentation-example-link");
liveUrl.href = examples[i].liveUrl;
liveUrl.textContent = WebInspector.UIString("Example");
}
- exampleDescription.appendChild(this._renderBlock(examples[i].description));
- var code = example.createChild("div", "documentation-example-code");
- code.classList.add("source-code");
+ var description = this._renderBlock(examples[i].description);
+ description.classList.add("documentation-text");
+ exampleDescription.appendChild(description);
+ var code = example.createChild("div", "documentation-example-code source-code");
code.textContent = examples[i].code;
if (!examples[i].language)
continue;
@@ -248,8 +272,7 @@ WebInspector.DocumentationView.Renderer.prototype = {
element = document.createElementWithClass("span", "documentation-code-tag");
break;
case elementTypes.CodeBlock:
- element = document.createElementWithClass("pre", "documentation-code");
- element.classList.add("source-code");
+ element = document.createElementWithClass("pre", "documentation-code source-code");
element.textContent = article.code();
break;
case elementTypes.PlainText:
@@ -301,12 +324,15 @@ WebInspector.DocumentationView.ContextMenuProvider.prototype = {
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));
+ }
},
/**

Powered by Google App Engine
This is Rietveld 408576698