mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
69d8ff147e
* [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
36 lines
1.5 KiB
Plaintext
36 lines
1.5 KiB
Plaintext
summary: >-
|
|
<%- ((typeof sig.comment !== "undefined") && (typeof sig.comment.shortText !== "undefined")) ? (sig.comment.shortText || "").replace(/[\n\r]+/g, " ").trim() : "" %>
|
|
tags:
|
|
<% if ((typeof sig.comment !== "undefined") && (typeof sig.comment.tags !== "undefined")) { -%>
|
|
<% sig.comment.tags.forEach(tag => { -%>
|
|
- name: <%= tag.tag %>
|
|
text: >-
|
|
<%= (tag.text || "").replace(/[\n\r]+/g, " ").trim() %>
|
|
<% }) -%>
|
|
<% } -%>
|
|
syntax:
|
|
parameters:
|
|
<% if ((typeof sig.parameters !== "undefined") && (sig.parameters.length > 0)) { -%>
|
|
<% sig.parameters.forEach((param) => { -%>
|
|
- id: <%= param.name %>
|
|
type: >-
|
|
<%- include("type", {type: param.type}).trim() %>
|
|
description: >-
|
|
<%- param.comment ? (param.comment.text || "").replace(/[\n\r]+/g, " ").trim() : "" %>
|
|
defaultValue: >-
|
|
<%- (typeof param.defaultValue !== "undefined") ? param.defaultValue : "" %>
|
|
flags:
|
|
<%_ if (typeof param.flags !== "undefined") { -%>
|
|
<%_ Object.keys(param.flags).forEach(flagName => { -%>
|
|
- name: <%= flagName %>
|
|
value: <%- param.flags[flagName] %>
|
|
<% }) -%>
|
|
<% } -%>
|
|
<% }) -%>
|
|
<% } -%>
|
|
return:
|
|
type: >-
|
|
<%- include("type", {type: sig.type}).trim() %>
|
|
summary: >-
|
|
<%- ((typeof sig.comment !== "undefined") && (typeof sig.comment.returns !== "undefined")) ? (sig.comment.returns || "").replace(/[\n\r]+/g, " ").trim() : "" %>
|