mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-31 17:38:48 +00:00
[ADF-3040] Replaced doc template engine to fix whitespace issues (#3356)
This commit is contained in:
committed by
Eugenio Romano
parent
c63dee50f1
commit
0e64efc4e2
23
tools/doc/templates/component.combyne
vendored
23
tools/doc/templates/component.combyne
vendored
@@ -1,23 +0,0 @@
|
||||
{% if hasInputs %}
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| -- | -- | -- | -- |
|
||||
{% each properties as prop %}
|
||||
{% if prop.isInput %}
|
||||
| {{{prop.name}}} | `{{{prop.type}}}` | {{{prop.defaultValue}}} | {{{prop.docText}}} |
|
||||
{% endif %}
|
||||
{% endeach %}
|
||||
{% endif %}
|
||||
{% if hasOutputs%}
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| -- | -- | -- |
|
||||
{% each properties as prop %}
|
||||
{% if prop.isOutput %}
|
||||
| {{prop.name}} | `{{{prop.type}}}` | {{{prop.docText}}} |
|
||||
{% endif %}
|
||||
{% endeach %}
|
||||
{% endif %}
|
23
tools/doc/templates/component.ejs
vendored
Normal file
23
tools/doc/templates/component.ejs
vendored
Normal file
@@ -0,0 +1,23 @@
|
||||
<% if (hasInputs) { %>
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| -- | -- | -- | -- |
|
||||
<% properties.forEach(function(prop) { -%>
|
||||
<% if (prop.isInput) { -%>
|
||||
| <%= prop.name %> | `<%- prop.type %>` | <%= prop.defaultValue %> | <%= prop.docText %> |
|
||||
<% } -%>
|
||||
<% }) -%>
|
||||
<% } %>
|
||||
<% if (hasOutputs) { %>
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| -- | -- | -- |
|
||||
<% properties.forEach(function(prop) { %>
|
||||
<% if (prop.isOutput) { %>
|
||||
| <%= prop.name %> | `<%- prop.type %>` | <%= prop.docText %> |
|
||||
<% } %>
|
||||
<% }) %>
|
||||
<% } %>
|
23
tools/doc/templates/directive.combyne
vendored
23
tools/doc/templates/directive.combyne
vendored
@@ -1,23 +0,0 @@
|
||||
{% if hasInputs %}
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| -- | -- | -- | -- |
|
||||
{% each properties as prop %}
|
||||
{% if prop.isInput %}
|
||||
| {{{prop.name}}} | `{{{prop.type}}}` | {{{prop.defaultValue}}} | {{{prop.docText}}} |
|
||||
{% endif %}
|
||||
{% endeach %}
|
||||
{% endif %}
|
||||
{% if hasOutputs%}
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| -- | -- | -- |
|
||||
{% each properties as prop %}
|
||||
{% if prop.isOutput %}
|
||||
| {{prop.name}} | `{{{prop.type}}}` | {{{prop.docText}}} |
|
||||
{% endif %}
|
||||
{% endeach %}
|
||||
{% endif %}
|
23
tools/doc/templates/directive.ejs
vendored
Normal file
23
tools/doc/templates/directive.ejs
vendored
Normal file
@@ -0,0 +1,23 @@
|
||||
<% if (hasInputs) { %>
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| -- | -- | -- | -- |
|
||||
<% properties.forEach(function(prop) { -%>
|
||||
<% if (prop.isInput) { -%>
|
||||
| <%= prop.name %> | `<%- prop.type %>` | <%= prop.defaultValue %> | <%= prop.docText %> |
|
||||
<% } -%>
|
||||
<% }) -%>
|
||||
<% } %>
|
||||
<% if (hasOutputs) { %>
|
||||
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| -- | -- | -- |
|
||||
<% properties.forEach(function(prop) { %>
|
||||
<% if (prop.isOutput) { %>
|
||||
| <%= prop.name %> | `<%- prop.type %>` | <%= prop.docText %> |
|
||||
<% } %>
|
||||
<% }) %>
|
||||
<% } %>
|
14
tools/doc/templates/service.combyne
vendored
14
tools/doc/templates/service.combyne
vendored
@@ -1,14 +0,0 @@
|
||||
|
||||
{% if hasMethods %}
|
||||
### Methods
|
||||
|
||||
{% each methods as meth %}- **{{meth.name}}**{{{meth.signature}}}{% if meth.returnsSomething %}: `{{{meth.returnType}}}`{% endif %}<br/>
|
||||
{{meth.docText}}
|
||||
{% each meth.params as param %}
|
||||
- *{{{param.name}}}:* `{{{param.type}}}` - {% if param.isOptional %}(Optional){% endif %}{{{param.docText}}}
|
||||
{% endeach %}
|
||||
{% if meth.returnsSomething %}
|
||||
- **Returns** `{{{meth.returnType}}}` - {{{meth.returnDocText}}}
|
||||
{% endif %}
|
||||
{% endeach %}
|
||||
{% endif %}
|
15
tools/doc/templates/service.ejs
vendored
Normal file
15
tools/doc/templates/service.ejs
vendored
Normal file
@@ -0,0 +1,15 @@
|
||||
|
||||
<% if (hasMethods) { %>
|
||||
### Methods
|
||||
|
||||
<% methods.forEach(function(meth) { -%>
|
||||
- **<%= meth.name %>**<%= meth.signature %><% if (meth.returnsSomething) { %>: `<%- meth.returnType %>`<% } %><br/>
|
||||
<%= meth.docText %>
|
||||
<% meth.params.forEach(function(param) { -%>
|
||||
- *<%= param.name%>:* `<%- param.type %>` - <% if (param.isOptional) { %>(Optional)<% } %><%= param.docText %>
|
||||
<% }) -%>
|
||||
<% if (meth.returnsSomething) { -%>
|
||||
- **Returns** `<%- meth.returnType %>` - <%= meth.returnDocText %>
|
||||
<% } -%>
|
||||
<% }) -%>
|
||||
<% } %>
|
5
tools/doc/templates/tutIndex.combyne
vendored
5
tools/doc/templates/tutIndex.combyne
vendored
@@ -1,5 +0,0 @@
|
||||
| Name | Level | Abstract |
|
||||
| -- | -- | -- |
|
||||
{% each tuts as tut %}
|
||||
| [**{{tut.title}}**]({{tut.link}}) | {{tut.level}} | {{tut.briefDesc}} |
|
||||
{% endeach %}
|
5
tools/doc/templates/tutIndex.ejs
vendored
Normal file
5
tools/doc/templates/tutIndex.ejs
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
| Name | Level | Abstract |
|
||||
| -- | -- | -- |
|
||||
<% tuts.forEach(function(tut) { -%>
|
||||
| [**<%= tut.title %>**](<%= tut.link %>) | <%= tut.level %> | <%= tut.briefDesc %> |
|
||||
<% }) %>
|
3
tools/doc/templates/versIndex.combyne
vendored
3
tools/doc/templates/versIndex.combyne
vendored
@@ -1,3 +0,0 @@
|
||||
{% each items as item %}
|
||||
- [{{item.title}}]({{item.link}})
|
||||
{% endeach %}
|
3
tools/doc/templates/versIndex.ejs
vendored
Normal file
3
tools/doc/templates/versIndex.ejs
vendored
Normal file
@@ -0,0 +1,3 @@
|
||||
<% items.forEach(function(item) { -%>
|
||||
- [<%= item.title %>](<%= item.link %>)
|
||||
<% }) %>
|
Reference in New Issue
Block a user