mirror of
https://github.com/ionic-team/ionic-framework.git
synced 2025-08-24 14:58:36 +08:00
102 lines
2.8 KiB
HTML
102 lines
2.8 KiB
HTML
---
|
|
<@ include "lib/yaml.template.html" @>
|
|
title: "<@ if doc.docType == "directive" @><$ doc.name | dashCase $><@ else @><$ doc.name $><@ endif @>"
|
|
header_sub_title: "<$ doc.docType $> in module <$ doc.module $>"
|
|
doc: "<$ doc.name $>"
|
|
docType: "<$ doc.docType $>"
|
|
---
|
|
|
|
<@ macro paramList(paramData) -@>
|
|
<@- if paramData -@><span class="params">(
|
|
<@- for param in paramData -@>
|
|
<span class="param"><$ param | escape $><@ if not loop.last @>, <@ endif @></span>
|
|
<@- endfor @>)</span>
|
|
<@- endif @>
|
|
<@- endmacro -@>
|
|
<@ macro githubViewLink(doc) -@>
|
|
<a href="https://github.com/<$ versionInfo.gitRepoInfo.owner $>/<$ versionInfo.gitRepoInfo.repo $>/tree/master/<$ doc.fileInfo.relativePath $>#L<$ doc.location.start.line+1 $>-L<$ doc.location.end.line+1 $>"><$ doc.fileInfo.relativePath $> (line <$ doc.location.start.line+1 $>)</a>
|
|
<@- endmacro -@>
|
|
|
|
<@ block body @>
|
|
<div class="improve-docs">
|
|
<a href='http://github.com/driftyco/ionic/tree/master/<$ doc.relativePath $>#L<$ doc.startingLine $>'>
|
|
View Source
|
|
</a>
|
|
|
|
<a href='http://github.com/driftyco/ionic/edit/master/<$ doc.relativePath $>#L<$ doc.startingLine $>'>
|
|
Improve this doc
|
|
</a>
|
|
</div>
|
|
|
|
<@ block content @>
|
|
|
|
<@ block header @>
|
|
<h1 class="api-title">
|
|
<@ if doc.docType == "directive" @>
|
|
<$ doc.name | dashCase $>
|
|
<@ else @>
|
|
<$ doc.name $>
|
|
<@ endif @>
|
|
<@ if doc.parent @>
|
|
<br />
|
|
<small>
|
|
Child of <$ doc.parent $>
|
|
</small>
|
|
<@ endif @>
|
|
<@ if doc.delegate @>
|
|
<br/>
|
|
<small>
|
|
Delegate: <$ doc.delegate $>
|
|
</small>
|
|
<@ endif @>
|
|
</h1>
|
|
|
|
<@ if doc.codepen @>
|
|
{% include codepen.html id="<$ doc.codepen $>" %}
|
|
<@ endif @>
|
|
<@ endblock @>
|
|
|
|
<@ block description @>
|
|
<$ doc.description $>
|
|
<@ endblock @>
|
|
<h1 class="class export"><$ doc.name $> <span class="type"><$ doc.docType $></span></h1>
|
|
<p class="module">exported from {@link <$ doc.moduleDoc.id $> <$doc.moduleDoc.id $> }<br/>
|
|
defined in <$ githubViewLink(doc) $>
|
|
</p>
|
|
<p><$ doc.description | marked $></p>
|
|
|
|
<@- if doc.decorators @>
|
|
<h2>Annotations</h2>
|
|
<@- for decorator in doc.decorators @>
|
|
<h3 class="annotation">@<$ decorator.name $><$ paramList(decorator.arguments) $></h3>
|
|
<@ endfor @>
|
|
<@ endif -@>
|
|
|
|
<@- if doc.constructorDoc or doc.members.length -@>
|
|
<h2>Members</h2>
|
|
|
|
<@- if doc.constructorDoc @>
|
|
<section class="member constructor">
|
|
<h1 id="constructor" class="name"><$ doc.constructorDoc.name $><$ paramList(doc.constructorDoc.paramData) $></h1>
|
|
<@ marked @>
|
|
<$ doc.constructorDoc.description $>
|
|
<@ endmarked @>
|
|
</section>
|
|
<@ endif -@>
|
|
|
|
<@- for member in doc.members @><@ if not member.private @>
|
|
<section class="member">
|
|
<h1 id="<$ member.name $>" class="name">
|
|
<$ member.name $><@ if member.optional @>?<@ endif @><$ paramList(member.params) $>
|
|
</h1>
|
|
<@ marked @>
|
|
<$ member.description $>
|
|
<@ endmarked @>
|
|
</section>
|
|
|
|
<@ endif @><@ endfor @>
|
|
<@- endif -@>
|
|
|
|
<@ endblock @>
|
|
<@ endblock @>
|