DevTools: [Documentation] Update parser for WikiText

Source/devtools/front_end/documentation/JSArticle.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
  */
 WebInspector.JSArticle = function()
 {
     /** @type {string} */
     this.pageTitle;
     /** @type {string} */
     this.standardizationStatus;
     /** @type {?WebInspector.WikiParser.Block} */
     this.summary;
     /** @type {!Array.<!WebInspector.JSArticle.Parameter>} */
     this.parameters = [];
     /** @type {?WebInspector.JSArticle.Method} */
     this.methods;
     /** @type {?WebInspector.WikiParser.Block} */
     this.remarks;
     /** @type {!Array.<!WebInspector.JSArticle.Example>} */
     this.examples = [];
 }
 
 /**
  * @constructor
- * @param {string} name
- * @param {string} dataType
- * @param {string} optional
+ * @param {?WebInspector.WikiParser.Block} name
+ * @param {?WebInspector.WikiParser.Block} dataType
+ * @param {?WebInspector.WikiParser.Block} optional
  * @param {?WebInspector.WikiParser.Block} description
  */
 WebInspector.JSArticle.Parameter = function(name, dataType, optional, description)
 {
-    this.name = name;
-    this.dataType = dataType;
-    this.optional = optional.toUpperCase() === "YES";
+    this.name = name ? name.children()[0].children()[0].text() : null;

[lushnikov, 2014/09/08 14:08:30]

That's a very risky code. Who guarantees there'll be always a child in name,
which has a child, which has text?

[iliia, 2014/09/08 15:20:50]

It was one simple plain text before, but now it's inside block.
On 2014/09/08 14:08:30, lushnikov wrote:

+    this.dataType = dataType ? dataType.children()[0].children()[0].text() : null;

[lushnikov, 2014/09/08 14:08:30]

ditto

[iliia, 2014/09/08 15:20:50]

Done.

+    this.optional = optional ? optional.children()[0].children()[0].text().toUpperCase() === "YES" : false;
     this.description = description;
 }
 
 /**
  * @constructor
- * @param {string} language
+ * @param {?WebInspector.WikiParser.Block} language
  * @param {string} code
- * @param {string} liveUrl
+ * @param {?WebInspector.WikiParser.Block} liveUrl
  * @param {?WebInspector.WikiParser.Block} description
  */
 WebInspector.JSArticle.Example = function(language, code, liveUrl, description)
 {
-    this.language = language;
+    this.language = language ? language.children()[0].children()[0].text() : null ;

[lushnikov, 2014/09/08 14:08:30]

you should not address that deep structures without checks. this will be an
exception otherwise.

[iliia, 2014/09/08 15:20:50]

Done.

     this.code = code;
-    this.liveUrl = liveUrl;
+    this.liveUrl = liveUrl ? liveUrl.children()[0].children()[0].text() : null;
     this.description = description;
 }
 
 /**
  * @constructor
- * @param {string} returnValueName
- * @param {string} returnValueDescription
+ * @param {?WebInspector.WikiParser.Block} returnValueName
+ * @param {?WebInspector.WikiParser.Block} returnValueDescription
  */
 WebInspector.JSArticle.Method = function(returnValueName, returnValueDescription)
 {
-    this.returnValueName = returnValueName;
-    this.returnValueDescription = returnValueDescription;
+    this.returnValueName = returnValueName ? returnValueName.children()[0].children()[0].text() : null;

[lushnikov, 2014/09/08 14:08:30]

ditto

[iliia, 2014/09/08 15:20:50]

Done.

+    this.returnValueDescription = returnValueDescription ? returnValueDescription.children()[0].children()[0].text() : null;
 }
 
 /**
  * @param {string} wikiMarkupText
  * @return {!WebInspector.JSArticle}
  */
 WebInspector.JSArticle.parse = function(wikiMarkupText)
 {
-    /**
-     * @param {string} string
-     * @param {string} debugInfo
-     * @return {?WebInspector.WikiParser.Block}
-     */
-    function parseString(string, debugInfo)
-    {
-        var result = wikiParser.parseString(string);
-        if (!result)
-            console.error("Can't parse " + debugInfo);
-        return result;
-    }
-
     var wikiParser = new WebInspector.WikiParser(wikiMarkupText);
     var wikiDocument = wikiParser.document();
-
     var article = new WebInspector.JSArticle();
     article.pageTitle = wikiDocument["Page_Title"];
     if (typeof article.pageTitle !== "string")
         delete article.pageTitle;
     article.standardizationStatus = wikiDocument["Standardization_Status"];
     if (article.standardizationStatus !== "string")
         delete article.standardizationStatus;
     var apiObjectMethod = wikiDocument["API_Object_Method"];
     if (apiObjectMethod) {
         var returnValueName = apiObjectMethod["Javascript_data_type"];
         var returnValue = apiObjectMethod["Return_value_description"];
         if (returnValueName && returnValue)
             article.methods = new WebInspector.JSArticle.Method(returnValueName, returnValue);
     }
 
     var remarks = wikiDocument["Remarks_Section"] ? wikiDocument["Remarks_Section"]["Remarks"] : null;

[lushnikov, 2014/09/08 14:08:30]

article.remarks = ...

[iliia, 2014/09/08 15:20:50]

Done.

     if (remarks)
-        article.remarks = parseString(remarks, "remarks");
+        article.remarks = remarks;
 
     var summary = wikiDocument["Summary_Section"];

[lushnikov, 2014/09/08 14:08:30]

article.summary =...

[iliia, 2014/09/08 15:20:50]

Done.

     if (summary)
-        article.summary = parseString(summary, "summary");
+        article.summary = summary;
 
     var examples = wikiDocument["Examples_Section"] ? wikiDocument["Examples_Section"]["Examples"] : [];
     if (!Array.isArray(examples) && typeof examples !== "undefined")
         examples = [examples];
 
     for (var i = 0; i < examples.length; ++i) {
         var language = examples[i]["Single Example"]["Language"];
         var code = examples[i]["Single Example"]["Code"];
         var liveUrl = examples[i]["Single Example"]["LiveURL"];
-        var description = parseString(examples[i]["Single Example"]["Description"], "example description");
+        var description = examples[i]["Single Example"]["Description"];
         article.examples.push(new WebInspector.JSArticle.Example(language, code, liveUrl, description));
     }
 
     var parameters = apiObjectMethod ? apiObjectMethod["Parameters"] : [];
     if (!Array.isArray(parameters) && typeof parameters !== "undefined")
         parameters = [parameters];
 
     for (var i = 0; i < parameters.length; ++i) {
         var name = parameters[i]["Method Parameter"]["Name"];
         var dataType = parameters[i]["Method Parameter"]["Data type"];
         var optional = parameters[i]["Method Parameter"]["Optional"];
-        var description = parseString(parameters[i]["Method Parameter"]["Description"], "method description");
+        var description = parameters[i]["Method Parameter"]["Description"];
         article.parameters.push(new WebInspector.JSArticle.Parameter(name, dataType, optional, description));
     }
 
     return article;
 }