mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-3323] Updated doc tools to use DocFX intermediate files (#3601)
* [ADF-3323] Moved source file parsing to main doc tool * [ADF-3323] Moved source info classes * [ADF-3323] Added doc YAML generator tool * [ADF-3323] Added doc YAML/JSON source paths to gitignore * [ADF-3323] Completed templates and template context code * [ADF-3323] Added source paths and updated type linker * [ADF-3323] Final fixes to templates and type linking * [ADF-3323] Fixed filter for private and protected methods * [ADF-3323] Content services docs after check and rebuild * [ADF-3323] Updated docbuild script in package.json
This commit is contained in:
committed by
Eugenio Romano
parent
54380fd693
commit
69d8ff147e
44
tools/doc/yamlTemplates/template.ejs
Normal file
44
tools/doc/yamlTemplates/template.ejs
Normal file
@@ -0,0 +1,44 @@
|
||||
items:
|
||||
- uid: <%= name %>
|
||||
name: <%= name %>
|
||||
fullName: <%= name %>
|
||||
source:
|
||||
path: <%= sources[0].fileName %>
|
||||
startLine: <%= sources[0].line %>
|
||||
children:
|
||||
<%_ if (typeof children !== "undefined") { -%>
|
||||
<%_ children.forEach((child) => { -%>
|
||||
- <%= name %>.<%= child.name %>
|
||||
<% }) -%>
|
||||
<% } -%>
|
||||
langs: typeScript
|
||||
type: <%= kindString.toLowerCase() %>
|
||||
<%_ if (typeof children !== "undefined") { -%>
|
||||
<%_ children.forEach((child) => { -%>
|
||||
<%_ if ((child.kindString === "Constructor") || (child.kindString === "Method")) { -%>
|
||||
<%_ child.signatures.forEach((sig) => { -%>
|
||||
- uid: <%= name %>.<%= child.name %>
|
||||
name: <%= child.name %>
|
||||
type: <%= child.kindString.toLowerCase() %>
|
||||
flags:
|
||||
<%_ if (typeof child.flags !== "undefined") { -%>
|
||||
<%_ Object.keys(child.flags).forEach(flagName => { -%>
|
||||
- name: <%= flagName %>
|
||||
value: <%= child.flags[flagName] %>
|
||||
<% }) -%>
|
||||
<% } -%>
|
||||
<%- include("methodSig", {sig: sig}); -%>
|
||||
<% }); %>
|
||||
<% } else if (child.kindString === "Property") { -%>
|
||||
- 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}); -%>
|
||||
<% } -%>
|
||||
<% }) -%>
|
||||
<% } -%>
|
Reference in New Issue
Block a user