{% import "lib/githubLinks.html" as github -%}
{% import "lib/paramList.html" as params -%}
{% extends 'layout/base.template.html' %}

{% block body %}
include {$ relativePath(doc.path, '_util-fns') $}

{% include "layout/_what-it-does.html" %}

{% include "layout/_security-notes.html" %}

{% include "layout/_deprecated-notes.html" %}

{% include "layout/_how-to-use.html" %}

div(layout="row" layout-xs="column" class="row-margin ng-cloak")
  div(flex="20" flex-xs="100")
    h2(class="h2-api-docs") Description
  div(class="code-links" flex="80" flex-xs="100")
    :marked
      {%- if not doc.notYetDocumented %}
{$ doc.description | indentForMarkdown(6) | trimBlankLines $}
      {% endif %}

{% if doc.metadataDoc and doc.metadataDoc.members.length %}
div(layout="row" layout-xs="column" class="metadata" class="row-margin ng-cloak")
  div(flex="20" flex-xs="100")
    h2(class="h2-api-docs") Metadata Properties
  div(class="code-links" flex="80" flex-xs="100")
    {% for metadata in doc.metadataDoc.members %}{% if not metadata.internal %}
    a(name="{$ metadata.name $}-anchor" class="anchor-offset")
    pre(class="prettyprint no-bg" ng-class="{ 'anchor-focused': appCtrl.isApiDocMemberFocused('{$ metadata.name $}') }")
      code(class="api-doc-code").
        {$ metadata.name $}{$ params.paramList(metadata.parameters) | indent(8, false) | trim $}{$ params.returnType(metadata.returnType) $}

    :marked
      {%- if not metadata.notYetDocumented %}
{$ metadata.description | indentForMarkdown(6) | replace('### Example', '') | replace('## Example', '') | replace('# Example', '') | trimBlankLines $}
      {% endif -%}

    {% if not loop.last %}
    .hr(class="hr-margin")
    {% endif %}

  {% endif %}{% endfor %}
{% endif %}

p.location-badge.
  exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} } defined in {$ github.githubViewLink(doc, versionInfo) $}

{% endblock %}