[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:
Andy Stark
2018-03-28 10:20:29 +01:00
committed by Eugenio Romano
parent c803e9f753
commit 21b8cd30ce
6 changed files with 440 additions and 1 deletions

View 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 %}

View File

@@ -0,0 +1 @@
{% include 'component' %}

View 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 %}