dgeni-alive/src/templates/lib/methods.template.html

Live doc generator on top of Dgeni

{%- if doc.methods %}
<h2>Methods</h2>
<ul class="methods">
  {%- for method in doc.methods %}
  <li id="{$ method.name $}">
    <h3 class="{% if method.deprecated != null %}member-deprecated{% endif %}">
      <span class="title">{$ lib.functionSyntax(method) $}</span>
      {$ lib.memberAccess(method) $}
      {$ lib.deprecatedOrSince(method) $}
    </h3>
    <div>{$ method.description | marked $}</div>

    {% if method.params %}
    <h4>Parameters</h4>
    {$ lib.paramTable(method.params) $}
    {% endif %}

    {% if method.this %}
    <h4>Method's {% code %}this{% endcode %}</h4>
    {$ method.this | marked $}
    {% endif %}
    
    {% if method.returns %}
    <h4>Returns</h4>
    {$ lib.typeInfo(method.returns) $}
    {% endif %}

    {% if method.throws %}
    <h4>Throws</h4>
    {$ lib.typeInfo(method.throws) $}
    {% endif %}
  </li>
  {% endfor -%}
</ul>
{%- endif -%}