mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-2557] Added new prop table script with support for "deprecated" tags (#3126)
* [ADF-2557] Initial test of typedoc props script * [ADF-2557] Added simple table generation and support for deprecated tag * [ADF-2557] Added templates and simple method list * [ADF-2557] Finished method features and added new templates * [ADF-2557] Updated templates and added Markdown insertion
This commit is contained in:
committed by
Eugenio Romano
parent
c803e9f753
commit
21b8cd30ce
17
lib/config/DocProcessor/templates/component.liquid
Normal file
17
lib/config/DocProcessor/templates/component.liquid
Normal file
@@ -0,0 +1,17 @@
|
||||
{% if hasInputs -%}
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default value | Description |
|
||||
| -- | -- | -- | -- |
|
||||
{% for prop in properties %}{% if prop.isInput %}| {{prop.name}} | `{{prop.type}}` | {{prop.defaultValue}} | {% if prop.isDeprecated %}(Deprecated) {% endif %}{{prop.docText}} |
|
||||
{% endif %}{% endfor %}
|
||||
{% endif %}
|
||||
|
||||
{% if hasOutputs -%}
|
||||
### Events
|
||||
|
||||
| Name | Type | Description |
|
||||
| -- | -- | -- |
|
||||
{% for prop in properties %}{% if prop.isOutput %}| {{prop.name}} | `{{prop.type}}` | {% if prop.isDeprecated %}(Deprecated) {% endif %}{{prop.docText}} |
|
||||
{% endif %}{% endfor %}
|
||||
{% endif %}
|
1
lib/config/DocProcessor/templates/directive.liquid
Normal file
1
lib/config/DocProcessor/templates/directive.liquid
Normal file
@@ -0,0 +1 @@
|
||||
{% include 'component' %}
|
10
lib/config/DocProcessor/templates/service.liquid
Normal file
10
lib/config/DocProcessor/templates/service.liquid
Normal file
@@ -0,0 +1,10 @@
|
||||
|
||||
{% if hasMethods %}
|
||||
### Methods
|
||||
|
||||
{% for meth in methods %}- `{{meth.name}}{{meth.signature}}: {{meth.returnType}}`<br/>
|
||||
{{meth.docText}}
|
||||
{% for param in meth.params %} - `{{param.combined}}` - {% if param.isOptional %}(Optional){% endif %}{{param.docText}}
|
||||
{% endfor %}
|
||||
{% endfor %}
|
||||
{% endif %}
|
Reference in New Issue
Block a user