[ADF-3587] Fixed doc comment problems (#3822)

* [ADF-3587] Fixed missing docs for accessor properties

* [ADF-3587] Fixed badly formed doc comments with deprecated tag

* [ADF-3587] Fixed linting issue with doc comment
This commit is contained in:
Andy Stark
2018-09-25 21:45:16 +01:00
committed by Eugenio Romano
parent 95a91c670d
commit 431bde3ddf
27 changed files with 105 additions and 60 deletions

View File

@@ -294,6 +294,7 @@ var ComponentInfo = /** @class */ (function () {
sourceData.items.forEach(function (item) {
switch (item.type) {
case "property":
case "accessor":
var prop = new PropInfo(item);
_this.properties.push(prop);
if (prop.isInput) {

View File

@@ -370,6 +370,7 @@ export class ComponentInfo {
sourceData.items.forEach(item => {
switch(item.type) {
case "property":
case "accessor":
var prop = new PropInfo(item);
this.properties.push(prop);

View File

@@ -0,0 +1,6 @@
syntax:
return:
type: >-
<%- include("type", {type: child.type}).trim() %>
defaultValue: >-
<%- (child.defaultValue || "").length < 20 ? child.defaultValue : "" %>

View File

@@ -21,9 +21,3 @@
<% } -%>
<%_ }) -%>
<% } -%>
syntax:
return:
type: >-
<%- include("type", {type: child.type}).trim() %>
defaultValue: >-
<%- (child.defaultValue || "").length < 20 ? child.defaultValue : "" %>

View File

@@ -29,16 +29,20 @@ items:
<% } -%>
<%- include("methodSig", {sig: sig}); -%>
<% }); %>
<% } else if (child.kindString === "Property") { -%>
<% } else if ((child.kindString === "Property") || (child.kindString === "Accessor")) { -%>
- uid: <%= name %>.<%= child.name %>
name: <%= child.name %>
type: <%= child.kindString.toLowerCase() %>
<%- include("property", {child: child}); -%>
<% } else if ((child.kindString === "Accessor") && (typeof child.getSignature !== "undefined")) { -%>
- uid: <%= name %>.<%= child.name %>
name: <%= child.name %>
type: <%= child.kindString.toLowerCase() %>
<%- include("property", {child: child.getSignature}); -%>
<% if (child.kindString === "Accessor") { -%>
<% if (typeof child.getSignature !== "undefined") { -%>
<%- include("propSyntaxSection", {child: child.getSignature}); -%>
<% } else if (typeof child.setSignature !== "undefined") { -%>
<%- include("propSyntaxSection", {child: child.setSignature}); -%>
<% } -%>
<% } else { -%>
<%- include("propSyntaxSection", {child: child}); -%>
<% } -%>
<% } -%>
<% }) -%>
<% } -%>