angular/angular.js

View on GitHub
docs/config/templates/ngdoc/lib/methods.template.html

Summary

Maintainability
Test Coverage
{% import "lib/macros.html" as lib -%}
{% import "lib/deprecated.html" as x -%}

{%- if doc.methods %}
<h2 id="{$ doc.name $}-methods">Methods</h2>
<ul class="methods">
  {%- for method in doc.methods %}
  <li>
    <h3 id="{$ method.name $}">{$ lib.functionSyntax(method) $}</h3>
    <div>{$ method.description | marked $}</div>

    {$ x.deprecatedBlock(method) $}

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

    {% if method.this %}
    <h4>Method's `this`</h4>
    {$ method.this | marked $}
    {% endif %}

    {% if method.returns %}
    <h4>Returns</h4>
    {$ lib.typeInfo(method.returns) $}
    {% endif %}

    {%- if method.examples %}
    <h4 id="{$ doc.name $}.{$ method.name $}-examples">{$ "Examples" if method.examples | length > 1 else "Example" $}</h4>
    {%- for example in method.examples -%}
      {$ example | marked $}
    {%- endfor -%}
    {% endif -%}

  </li>
  {% endfor -%}
</ul>
{%- endif -%}