mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[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:
committed by
Eugenio Romano
parent
95a91c670d
commit
431bde3ddf
6
tools/doc/yamlTemplates/propSyntaxSection.ejs
Normal file
6
tools/doc/yamlTemplates/propSyntaxSection.ejs
Normal file
@@ -0,0 +1,6 @@
|
||||
syntax:
|
||||
return:
|
||||
type: >-
|
||||
<%- include("type", {type: child.type}).trim() %>
|
||||
defaultValue: >-
|
||||
<%- (child.defaultValue || "").length < 20 ? child.defaultValue : "" %>
|
@@ -21,9 +21,3 @@
|
||||
<% } -%>
|
||||
<%_ }) -%>
|
||||
<% } -%>
|
||||
syntax:
|
||||
return:
|
||||
type: >-
|
||||
<%- include("type", {type: child.type}).trim() %>
|
||||
defaultValue: >-
|
||||
<%- (child.defaultValue || "").length < 20 ? child.defaultValue : "" %>
|
||||
|
@@ -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}); -%>
|
||||
<% } -%>
|
||||
<% } -%>
|
||||
<% }) -%>
|
||||
<% } -%>
|
Reference in New Issue
Block a user