dgeni-markdown/templates/api/object.template.md

dgeni markdown template for generating documentation from source code

{% import "lib/macros.md" as lib %}
{% extends "api/api.template.md" %}

{% block additional %}  

{% if doc.params or doc.returns or doc.this or doc.kind == 'function' -%}
## Usage
{% if doc.usage %}
```
{$ doc.usage $}
```

{% else %}
{%- set sep = joiner(', ') -%}

```js
{$ doc.name $}({%- for param in doc.params %}{$ sep() $}{%- if param.type.optional %}[{% endif -%}{$ param.name $}{%- if param.type.optional %}]{% endif -%}{% endfor %});
```

{% endif %}

{% include "lib/params.template.md" %}
{% include "lib/this.template.md" %}
{% include "lib/returns.template.md" %}
{%- endif %}

{% include "lib/methods.template.md" %}
{% include "lib/events.template.md" %}
{% include "lib/properties.template.md" %}

{% endblock %}