mirror of
https://github.com/ionic-team/ionic-framework.git
synced 2026-03-13 10:22:08 +08:00
add api menu templates
This commit is contained in:
52
scripts/docs/templates/common.template.html
vendored
52
scripts/docs/templates/common.template.html
vendored
@@ -1,51 +1,51 @@
|
||||
{% 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) -%}
|
||||
<@ 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 -%}
|
||||
<@- endmacro -@>
|
||||
|
||||
{% block body %}
|
||||
<@ block body @>
|
||||
<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 %}
|
||||
<@- if doc.decorators @>
|
||||
<h2>Annotations</h2>
|
||||
{%- for decorator in doc.decorators %}
|
||||
<@- for decorator in doc.decorators @>
|
||||
<h3 class="annotation">@{$ decorator.name $}{$ paramList(decorator.arguments) $}</h3>
|
||||
{% endfor %}
|
||||
{% endif -%}
|
||||
<@ endfor @>
|
||||
<@ endif -@>
|
||||
|
||||
{%- if doc.constructorDoc or doc.members.length -%}
|
||||
<@- if doc.constructorDoc or doc.members.length -@>
|
||||
<h2>Members</h2>
|
||||
|
||||
{%- if doc.constructorDoc %}
|
||||
<@- if doc.constructorDoc @>
|
||||
<section class="member constructor">
|
||||
<h1 id="constructor" class="name">{$ doc.constructorDoc.name $}{$ paramList(doc.constructorDoc.paramData) $}</h1>
|
||||
{% marked %}
|
||||
<@ marked @>
|
||||
{$ doc.constructorDoc.description $}
|
||||
{% endmarked %}
|
||||
<@ endmarked @>
|
||||
</section>
|
||||
{% endif -%}
|
||||
<@ endif -@>
|
||||
|
||||
{%- for member in doc.members %}{% if not member.private %}
|
||||
<@- 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) $}
|
||||
{$ member.name $}<@ if member.optional @>?<@ endif @>{$ paramList(member.params) $}
|
||||
</h1>
|
||||
{% marked %}
|
||||
<@ marked @>
|
||||
{$ member.description $}
|
||||
{% endmarked %}
|
||||
<@ endmarked @>
|
||||
</section>
|
||||
|
||||
{% endif %}{% endfor %}
|
||||
{%- endif -%}
|
||||
<@ endif @><@ endfor @>
|
||||
<@- endif -@>
|
||||
|
||||
{% endblock %}
|
||||
<@ endblock @>
|
||||
|
||||
Reference in New Issue
Block a user