build(aio): move doc-gen stuff from angular.io (#14097)
This commit is contained in:
committed by
Igor Minar
parent
d1d0ce7613
commit
b7763559cd
+15
@@ -0,0 +1,15 @@
|
||||
[{% for module, items in doc.data %}
|
||||
{% for item in items %}
|
||||
{
|
||||
"title": "{$ item.title $}",
|
||||
"path": "{$ item.exportDoc.path $}",
|
||||
"docType": "{$ item.docType $}",
|
||||
"stability": "{$ item.stability $}",
|
||||
"secure": "{$ item.security $}",
|
||||
"howToUse": "{$ item.howToUse | replace('"','\\"') $}",
|
||||
"whatItDoes": {% if item.whatItDoes %}"Exists"{% else %}"Not Done"{% endif %},
|
||||
"barrel" : "{$ module | replace("/index", "") $}"
|
||||
}{% if not loop.last %},{% endif %}
|
||||
{% endfor %}
|
||||
{% endfor %}
|
||||
]
|
||||
+14
@@ -0,0 +1,14 @@
|
||||
{
|
||||
{%- for module, items in doc.data %}
|
||||
"{$ module | replace("/index", "") $}" : [{% for item in items %}
|
||||
{
|
||||
"title": "{$ item.title $}",
|
||||
"path": "{$ item.exportDoc.path $}",
|
||||
"docType": "{$ item.docType $}",
|
||||
"stability": "{$ item.stability $}",
|
||||
"secure": "{$ item.security $}",
|
||||
"barrel" : "{$ module | replace("/index", "") $}"
|
||||
}{% if not loop.last %},{% endif %}
|
||||
{% endfor %}]{% if not loop.last %},{% endif %}
|
||||
{% endfor -%}
|
||||
}
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"currentEnvironment": {$ doc.currentEnvironment | json | trim $},
|
||||
"version": {$ doc.version.currentVersion | json | indent(2) | trim $},
|
||||
"sections": {$ doc.sections | json | indent(2) | trim $}
|
||||
}
|
||||
Vendored
+161
@@ -0,0 +1,161 @@
|
||||
{% import "lib/githubLinks.html" as github -%}
|
||||
{% import "lib/paramList.html" as params -%}
|
||||
{% extends 'layout/base.template.html' -%}
|
||||
|
||||
{% block body %}
|
||||
|
||||
|
||||
{% 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="ng-cloak">
|
||||
<div flex="20" flex-xs="100">
|
||||
<h2 class="h2-api-docs">Class Overview</h2>
|
||||
</div>
|
||||
<div flex="80" flex-xs="100">
|
||||
<code class="no-bg api-doc-code openParens">class {$ doc.name $} {</code>
|
||||
{% if doc.statics.length %}
|
||||
<div layout="column">
|
||||
{% for member in doc.statics %}{% if not member.internal %}
|
||||
<pre class="prettyprint no-bg-with-indent">static
|
||||
<a class="code-anchor" href="#{$ member.name $}-anchor">
|
||||
<code(class="code-background api-doc-code">{$ member.name | indent(6, false) | trim $}</code>
|
||||
</a>
|
||||
<code class="api-doc-code">
|
||||
{$ params.paramList(member.parameters) | indent(8, false) | trim $}{$ params.returnType(member.returnType) $}
|
||||
</code>
|
||||
{% endif %}{% endfor %}
|
||||
{% endif %}
|
||||
{% if doc.constructorDoc.name %}
|
||||
<div layout="column">
|
||||
<pre class="prettyprint no-bg-with-indent">
|
||||
<a class="code-anchor" href="#constructor">
|
||||
<code class="code-background api-doc-code">{$ doc.constructorDoc.name $}</code>
|
||||
</a>
|
||||
<code class="api-doc-code">
|
||||
{$ params.paramList(doc.constructorDoc.parameters) | indent(8, false) | trim $}
|
||||
</code>
|
||||
{% endif %}
|
||||
{% if doc.members.length %}
|
||||
<div layout="column">
|
||||
{% for member in doc.members %}{% if not member.internal %}
|
||||
<pre class="prettyprint no-bg-with-indent">
|
||||
<a class="code-anchor" href="#{$ member.name $}-anchor">
|
||||
<code class="code-background api-doc-code">{$ member.name | indent(6, false) | trim $}</code>
|
||||
</a>
|
||||
<code class="api-doc-code">{$ params.paramList(member.parameters) | indent(8, false) | trim $}{$ params.returnType(member.returnType) $}</code>
|
||||
</pre>
|
||||
{% endif %}{% endfor %}
|
||||
{% endif %}
|
||||
<p class="selector endParens">
|
||||
<code class="api-doc-code no-bg">}</code>
|
||||
</p>
|
||||
|
||||
{% block additional %}
|
||||
{% endblock %}
|
||||
|
||||
<div layout="row" layout-xs="column" class="row-margin ng-cloak">
|
||||
<div flex="20" flex-xs="100">
|
||||
<h2 class="h2-api-docs">Class Description</h2>
|
||||
</div>
|
||||
<div class="code-links" flex="80" flex-xs="100">
|
||||
{%- if doc.description.length > 2 %}
|
||||
{$ doc.description | trimBlankLines | marked $}
|
||||
{% endif %}
|
||||
</div>
|
||||
|
||||
{%- if doc.decorators.length %}
|
||||
{% block annotations %}
|
||||
<div layout="row" layout-xs="column" class="row-margin ng-cloak">
|
||||
<div flex="20" flex-xs="100">
|
||||
<h2 class="h2-api-docs">Annotations</h2>
|
||||
</div>
|
||||
<div flex="80" flex-xs="100">
|
||||
{%- for decorator in doc.decorators %}
|
||||
<pre class="prettyprint no-bg">
|
||||
<code class="api-doc-code">
|
||||
@{$ decorator.name $}{$ params.paramList(decorator.arguments) | indent(10, false) $}
|
||||
</code>
|
||||
</pre>
|
||||
{%- if not decorator.notYetDocumented %}
|
||||
{$ decorator.description | indentForMarkdown(8) | trimBlankLines | marked $}
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
</div>
|
||||
{% endblock %}
|
||||
{% endif %}
|
||||
|
||||
{%- if doc.constructorDoc and not doc.constructorDoc.internal %}
|
||||
<div layout="row" layout-xs="column" class="row-margin ng-cloak">
|
||||
<div flex="20" flex-xs="100">
|
||||
<h2 class="h2-api-docs">Constructor</h2>
|
||||
</div>
|
||||
<div flex="80" flex-xs="100">
|
||||
<a name="constructor" class="anchor-offset"></a>
|
||||
<pre class="prettyprint no-bg" ng-class="{ 'anchor-focused': appCtrl.isApiDocMemberFocused('{$ doc.constructorDoc.name $}') }">
|
||||
<code class="api-doc-code">
|
||||
{$ doc.constructorDoc.name $}{$ params.paramList(doc.constructorDoc.parameters) | indent(8, false) | trim $}
|
||||
</code>
|
||||
</pre>
|
||||
{%- if not doc.constructorDoc.notYetDocumented %}
|
||||
{$ doc.constructorDoc.description | replace('### Example', '') | replace('## Example', '') | replace('# Example', '') | trimBlankLines | marked $}
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
|
||||
{% if doc.statics.length %}
|
||||
<div layout="row" layout-xs="column" class="row-margin ng-cloak">
|
||||
<div flex="20" flex-xs="100">
|
||||
<h2 class="h2-api-docs">Static Members</h2>
|
||||
</div>
|
||||
<div class="code-links" flex="80" flex-xs="100">
|
||||
{% for member in doc.statics %}{% if not member.internal %}
|
||||
<a name="{$ member.name $}-anchor" class="anchor-offset"></a>
|
||||
<pre class="prettyprint no-bg" ng-class="{ 'anchor-focused': appCtrl.isApiDocMemberFocused('{$ member.name $}') }">
|
||||
<code class="api-doc-code">
|
||||
{$ member.name $}{$ params.paramList(member.parameters) | indent(8, false) | trim $}{$ params.returnType(member.returnType) $}
|
||||
</code>
|
||||
</pre>
|
||||
{%- if not member.notYetDocumented %}
|
||||
{$ member.description | replace('### Example', '') | replace('## Example', '') | replace('# Example', '') | trimBlankLines | marked $}
|
||||
{% endif %}
|
||||
|
||||
{% if not loop.last %}
|
||||
<hr class="hr-margin">
|
||||
{% endif %}
|
||||
|
||||
{% endif %}{% endfor %}
|
||||
{% endif %}
|
||||
|
||||
{% if doc.members.length %}
|
||||
<div layout="row" layout-xs="column" class="instance-members" class="row-margin ng-cloak">
|
||||
<div flex="20" flex-xs="100">
|
||||
<h2 class="h2-api-docs">Class Details</h2>
|
||||
</div>
|
||||
<div class="code-links" flex="80" flex-xs="100">
|
||||
{% for member in doc.members %}{% if not member.internal %}
|
||||
<a name="{$ member.name $}-anchor" class="anchor-offset">
|
||||
<pre class="prettyprint no-bg" ng-class="{ 'anchor-focused': appCtrl.isApiDocMemberFocused('{$ member.name $}') }">
|
||||
<code class="api-doc-code">
|
||||
{$ member.name $}{$ params.paramList(member.parameters) | indent(8, false) | trim $}{$ params.returnType(member.returnType) $}
|
||||
</code>
|
||||
</pre>
|
||||
{%- if not member.notYetDocumented %}
|
||||
{$ member.description | replace('### Example', '') | replace('## Example', '') | replace('# Example', '') | trimBlankLines | marked $}
|
||||
{% endif -%}
|
||||
|
||||
{% if not loop.last %}
|
||||
<hr class="hr-margin">
|
||||
{% endif %}
|
||||
{% endif %}{% endfor %}
|
||||
{% endif %}
|
||||
|
||||
<p class="location-badge">
|
||||
exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} },
|
||||
defined in {$ github.githubViewLink(doc, versionInfo) $}
|
||||
</p>
|
||||
{% endblock %}
|
||||
Vendored
+1
@@ -0,0 +1 @@
|
||||
{% extends 'var.template.html' -%}
|
||||
+1
@@ -0,0 +1 @@
|
||||
export const {$ doc.serviceName $} = {$ doc.value | json $};
|
||||
+44
@@ -0,0 +1,44 @@
|
||||
{% import "lib/githubLinks.html" as github -%}
|
||||
{% import "lib/paramList.html" as params -%}
|
||||
{% extends 'layout/base.template.html' %}
|
||||
|
||||
{% block body %}
|
||||
|
||||
|
||||
{% 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</h2>
|
||||
<div class="code-links" flex="80" flex-xs="100">
|
||||
{%- if not doc.notYetDocumented %}{$ doc.description | trimBlankLines | marked $}{% endif %}
|
||||
</div>
|
||||
</div>
|
||||
{% 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</h2>
|
||||
</div>
|
||||
<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"></a>
|
||||
<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) $}
|
||||
</code>
|
||||
</pre>
|
||||
{%- if not metadata.notYetDocumented %}{$ metadata.description | replace('### Example', '') | replace('## Example', '') | replace('# Example', '') | trimBlankLines | marked $}{% endif -%}
|
||||
{% if not loop.last %}<hr class="hr-margin">{% endif %}
|
||||
{% endif %}{% endfor %}
|
||||
{% endif %}
|
||||
|
||||
<p class="location-badge">
|
||||
exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} } defined in {$ github.githubViewLink(doc, versionInfo) $}
|
||||
</p>
|
||||
{% endblock %}
|
||||
+62
@@ -0,0 +1,62 @@
|
||||
{% import "lib/githubLinks.html" as github -%}
|
||||
{% import "lib/paramList.html" as params -%}
|
||||
{% extends 'class.template.html' -%}
|
||||
|
||||
{% block annotations %}
|
||||
{% endblock %}
|
||||
|
||||
{% block additional -%}
|
||||
|
||||
{%- if doc.directiveOptions.selector.split(',').length %}
|
||||
<div layout="row" layout-xs="column" class="row-margin ng-cloak">
|
||||
<div flex="20" flex-xs="100">
|
||||
<h2 class="h2-api-docs">Selectors</h2>
|
||||
<div flex="80" flex-xs="100">
|
||||
{% for selector in doc.directiveOptions.selector.split(',') %}
|
||||
<p class="selector">
|
||||
<code>{$ selector $}</code>
|
||||
</p>
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
|
||||
{% if doc.outputs %}
|
||||
<div layout="row" layout-xs="column" class="row-margin ng-cloak">
|
||||
<div flex="20" flex-xs="100">
|
||||
<h2 class="h2-api-docs">Outputs</h2>
|
||||
</div>
|
||||
<div flex="80" flex-xs="100">
|
||||
{% for binding, property in doc.outputs %}
|
||||
<div class="code-margin">
|
||||
<code>{$ property.bindingName $} bound to </code>
|
||||
<code>{$ property.memberDoc.classDoc.name $}.{$ property.propertyName $}</code
|
||||
</div>
|
||||
{$ property.memberDoc.description | trimBlankLines | marked $}
|
||||
</div>
|
||||
{% endfor %}
|
||||
</div>
|
||||
{% endif %}
|
||||
|
||||
{% if doc.inputs %}
|
||||
<div layout="row" layout-xs="column" class="row-margin ng-cloak">
|
||||
<div flex="20" flex-xs="100">
|
||||
<h2 class="h2-api-docs">Inputs</h2>
|
||||
<div flex="80" flex-xs="100">
|
||||
{% for binding, property in doc.inputs %}
|
||||
<div class="code-margin">
|
||||
<code>{$ property.bindingName $} bound to </code>
|
||||
<code>{$ property.memberDoc.classDoc.name $}.{$ property.propertyName $}</code>
|
||||
{$ property.memberDoc.description | trimBlankLines | marked $}
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
|
||||
{%- if doc.directiveOptions.exportAs %}
|
||||
<div layout="row" layout-xs="column" class="row-margin ng-cloak">
|
||||
<div flex="20" flex-xs="100">
|
||||
<h2 class="h2-api-docs">Exported as</h2>
|
||||
</div>
|
||||
<div flex="80" flex-xs="100">
|
||||
<p class="input">
|
||||
<code>{$ doc.directiveOptions.exportAs $}</code>
|
||||
</p>
|
||||
{% endif %}
|
||||
{% endblock %}
|
||||
Vendored
+1
@@ -0,0 +1 @@
|
||||
{% extends 'class.template.html' -%}
|
||||
+7
@@ -0,0 +1,7 @@
|
||||
<div class="code-example">
|
||||
{% marked %}
|
||||
```
|
||||
{$ doc.contents $}
|
||||
```
|
||||
{% endmarked %}
|
||||
</div>
|
||||
+31
@@ -0,0 +1,31 @@
|
||||
{% import "lib/githubLinks.html" as github -%}
|
||||
{% import "lib/paramList.html" as params -%}
|
||||
{% extends 'layout/base.template.html' -%}
|
||||
|
||||
{% block body %}
|
||||
|
||||
|
||||
{% 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">Class Export</h2>
|
||||
</div>
|
||||
<div class="code-links" flex="80" flex-xs="100">
|
||||
<pre class="prettyprint no-bg">
|
||||
<code>
|
||||
export {$ doc.name $}{$ params.paramList(doc.parameters) | indent(8, true) | trim $}{$ params.returnType(doc.returnType) $}
|
||||
</code>
|
||||
</pre>
|
||||
{%- if not doc.notYetDocumented %}{$ doc.description | trimBlankLines | marked $}{% endif %}
|
||||
|
||||
<p class="location-badge">
|
||||
exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} } defined in {$ github.githubViewLink(doc, versionInfo) $}
|
||||
</p>
|
||||
{% endblock %}
|
||||
+72
@@ -0,0 +1,72 @@
|
||||
{% import "lib/githubLinks.html" as github -%}
|
||||
{% import "lib/paramList.html" as params -%}
|
||||
{% extends 'layout/base.template.html' -%}
|
||||
|
||||
{% block body %}
|
||||
|
||||
|
||||
{% 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="ng-cloak">
|
||||
<div flex="20" flex-xs="100">
|
||||
<h2 class="h2-api-docs">Interface Overview</h2>
|
||||
</div>
|
||||
<div flex="80" flex-xs="100">
|
||||
<code class="no-bg api-doc-code openParens">interface {$ doc.name $} {</code>
|
||||
|
||||
{% if doc.members.length %}
|
||||
<div layout="column">
|
||||
{% for member in doc.members %}{% if not member.internal %}
|
||||
<pre class="prettyprint no-bg-with-indent">
|
||||
<a class="code-anchor" href="#{$ member.name $}-anchor">
|
||||
<code class="code-background api-doc-code">{$ member.name | indent(6, false) | trim $}</code>
|
||||
<code class="api-doc-code">{$ params.paramList(member.parameters) | indent(8, false) | trim $}{$ params.returnType(member.returnType) $}</code>
|
||||
</a>
|
||||
</pre>
|
||||
{% endif %}{% endfor %}
|
||||
{% endif %}
|
||||
<p class="selector endParens">
|
||||
<code class="api-doc-code no-bg">}</code>
|
||||
</p>
|
||||
|
||||
{% block additional %}
|
||||
{% endblock %}
|
||||
|
||||
<div layout="row" layout-xs="column" class="row-margin ng-cloak">
|
||||
<div flex="20" flex-xs="100">
|
||||
<h2 class="h2-api-docs">Interface Description</h2>
|
||||
</div>
|
||||
<div class="code-links" flex="80" flex-xs="100">
|
||||
{%- if doc.description.length > 2 %}{$ doc.description | trimBlankLines | marked $}{% endif %}
|
||||
</div>
|
||||
{% if doc.members.length %}
|
||||
<div layout="row" layout-xs="column" class="instance-members" class="row-margin ng-cloak">
|
||||
<div flex="20" flex-xs="100">
|
||||
<h2 class="h2-api-docs">Interface Details</h2>
|
||||
</div>
|
||||
<div class="code-links" flex="80" flex-xs="100">
|
||||
{% for member in doc.members %}{% if not member.internal %}
|
||||
<a name="{$ member.name $}-anchor" class="anchor-offset"></a>
|
||||
<pre class="prettyprint no-bg" ng-class="{ 'anchor-focused': appCtrl.isApiDocMemberFocused('{$ member.name $}') }">
|
||||
<code class="api-doc-code">
|
||||
{$ member.name $}{$ params.paramList(member.parameters) | indent(8, false) | trim $}{$ params.returnType(member.returnType) $}
|
||||
</code>
|
||||
</pre>
|
||||
{%- if not member.notYetDocumented %}{$ member.description | replace('### Example', '') | replace('## Example', '') | replace('# Example', '') | trimBlankLines | marked $}{% endif -%}
|
||||
{% if not loop.last %}<hr class="hr-margin">{% endif %}
|
||||
</div>
|
||||
{% endif %}{% endfor %}
|
||||
</div>
|
||||
{% endif %}
|
||||
|
||||
<p class="location-badge">
|
||||
exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} },
|
||||
defined in {$ github.githubViewLink(doc, versionInfo) $}
|
||||
</p>
|
||||
{% endblock %}
|
||||
+1
@@ -0,0 +1 @@
|
||||
{$ doc.data | json $}
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
{% if doc.showDeprecatedNotes %}
|
||||
<div layout="row" layout-xs="column" class="row-margin ng-cloak">
|
||||
<div flex="20" flex-xs="100">
|
||||
<h2 class="h2-api-docs">Deprecation Notes</h2>
|
||||
</div>
|
||||
<div flex="80" flex-xs="100">
|
||||
{%- if doc.deprecated %}{$ doc.deprecated | marked $}
|
||||
{% else %}<em>Not yet documented</em>{% endif %}
|
||||
</div>
|
||||
</div>
|
||||
{% endif %}
|
||||
+10
@@ -0,0 +1,10 @@
|
||||
{%- if doc.howToUse %}
|
||||
<div layout="row" layout-xs="column" class="row-margin ng-cloak">
|
||||
<div flex="20" flex-xs="100">
|
||||
<h2 class="h2-api-docs">How to use</h2>
|
||||
</div>
|
||||
<div flex="80" flex-xs="100">
|
||||
{$ doc.howToUse | marked $}
|
||||
</div>
|
||||
</div>
|
||||
{% endif %}
|
||||
+8
@@ -0,0 +1,8 @@
|
||||
<div layout="row" layout-xs="column" class="row-margin ng-cloak">
|
||||
<div flex="20" flex-xs="100">
|
||||
<h2 class="h2-api-docs">NgModule</h2>
|
||||
</div>
|
||||
<div class="code-links" flex="80" flex-xs="100">
|
||||
{$ doc.ngModule $}
|
||||
</div>
|
||||
</div>
|
||||
+10
@@ -0,0 +1,10 @@
|
||||
{% if doc.showSecurityNotes and doc.security %}
|
||||
<div layout="row" layout-xs="column" class="row-margin ng-cloak">
|
||||
<div flex="20" flex-xs="100">
|
||||
<h2 class="h2-api-docs">Security Risk</h2>
|
||||
</div>
|
||||
<div flex="80" flex-xs="100">
|
||||
{$ doc.security | marked $}
|
||||
</div>
|
||||
</div>
|
||||
{% endif %}
|
||||
+10
@@ -0,0 +1,10 @@
|
||||
{%- if doc.whatItDoes %}
|
||||
<div layout="row" layout-xs="column" class="row-margin ng-cloak">
|
||||
<div flex="20" flex-xs="100">
|
||||
<h2 class="h2-api-docs">What it does</h2>
|
||||
</div>
|
||||
<div flex="80" flex-xs="100">
|
||||
{$ doc.whatItDoes | marked $}
|
||||
</div>
|
||||
</div>
|
||||
{% endif %}
|
||||
+1
@@ -0,0 +1 @@
|
||||
{% block body %}{% endblock %}
|
||||
Vendored
+1
@@ -0,0 +1 @@
|
||||
{% extends 'var.template.html' -%}
|
||||
Vendored
+7
@@ -0,0 +1,7 @@
|
||||
{% macro githubHref(doc, versionInfo) -%}
|
||||
https://github.com/{$ versionInfo.gitRepoInfo.owner $}/{$ versionInfo.gitRepoInfo.repo $}/tree/{$ versionInfo.currentVersion.isSnapshot and versionInfo.currentVersion.SHA or versionInfo.currentVersion.raw $}/modules/{$ doc.fileInfo.projectRelativePath $}#L{$ doc.location.start.line+1 $}-L{$ doc.location.end.line+1 $}
|
||||
{%- endmacro %}
|
||||
|
||||
{% macro githubViewLink(doc, versionInfo) -%}
|
||||
<a href="{$ githubHref(doc, versionInfo) $}">{$ doc.fileInfo.projectRelativePath $}</a>
|
||||
{%- endmacro %}
|
||||
Vendored
+12
@@ -0,0 +1,12 @@
|
||||
{% macro paramList(params) -%}
|
||||
{%- if params -%}
|
||||
({%- for param in params -%}
|
||||
{$ param | escape $}{% if not loop.last %}, {% endif %}
|
||||
{%- endfor %})
|
||||
{%- endif %}
|
||||
{%- endmacro -%}
|
||||
|
||||
|
||||
{% macro returnType(returnType) -%}
|
||||
{%- if returnType %} : {$ returnType | escape $}{% endif -%}
|
||||
{%- endmacro -%}
|
||||
Vendored
+14
@@ -0,0 +1,14 @@
|
||||
{% import "lib/githubLinks.html" as github -%}
|
||||
{% extends 'layout/base.template.html' -%}
|
||||
|
||||
{% block body -%}
|
||||
<p class="location-badge">defined in {$ github.githubViewLink(doc, versionInfo) $}</p>
|
||||
<ul>
|
||||
{% for page in doc.childPages -%}
|
||||
<li>
|
||||
<!-- TODO: convert to hovercard -->
|
||||
<a href="{$ relativePath(doc.moduleFolder, page.exportDoc.path) $}">{$ page.title $}</a>
|
||||
</li>
|
||||
{% endfor %}
|
||||
</ul>
|
||||
{% endblock %}
|
||||
+74
@@ -0,0 +1,74 @@
|
||||
{% import "lib/githubLinks.html" as github -%}
|
||||
{% import "lib/paramList.html" as params -%}
|
||||
<!DOCTYPE html>
|
||||
<html>
|
||||
<head>
|
||||
<title></title>
|
||||
<style>
|
||||
body {
|
||||
max-width: 1000px;
|
||||
}
|
||||
h2 {
|
||||
margin-top: 20px;
|
||||
margin-bottom: 0;
|
||||
border-bottom: solid 1px black;
|
||||
}
|
||||
h3 {
|
||||
margin-top: 10px;
|
||||
margin-bottom: 0;
|
||||
padding-left: 20px;
|
||||
}
|
||||
h4 {
|
||||
padding-left: 30px;
|
||||
margin: 0;
|
||||
}
|
||||
.not-documented::after {
|
||||
content: "(not documented)";
|
||||
font-size: small;
|
||||
font-style: italic;
|
||||
color: red;
|
||||
}
|
||||
a {
|
||||
color: black;
|
||||
text-decoration: none;
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
|
||||
|
||||
<h1>Module Overview</h1>
|
||||
|
||||
{% for module in doc.modules %}
|
||||
|
||||
<h2>
|
||||
<code>{$ module.id $}{%- if module.public %} (public){% endif %}</code>
|
||||
</h2>
|
||||
|
||||
{% for export in module.exports %}
|
||||
<h3 {% if export.notYetDocumented %}class="not-documented"{% endif %}>
|
||||
<a href="{$ github.githubHref(export, versionInfo) $}">
|
||||
<code>{$ export.docType $} {$ export.name $}</code>
|
||||
</a>
|
||||
</h3>
|
||||
{%- if export.constructorDoc %}
|
||||
<h4 {% if export.constructorDoc.notYetDocumented %}class="not-documented"{% endif %}>
|
||||
<a href="{$ github.githubHref(export.constructorDoc, versionInfo) $}">
|
||||
<code>{$ export.constructorDoc.name $}{$ params.paramList(export.constructorDoc.params) $}</code>
|
||||
</a>
|
||||
</h4>
|
||||
{% endif -%}
|
||||
{%- for member in export.members %}
|
||||
<h4 {% if member.notYetDocumented %}class="not-documented"{% endif %}>
|
||||
<a href="{$ github.githubHref(member, versionInfo) $}">
|
||||
<code>{$ member.name $}{$ params.paramList(member.params) $}</code>
|
||||
</a>
|
||||
</h4>
|
||||
{% endfor %}
|
||||
|
||||
{% endfor %}
|
||||
|
||||
{% endfor %}
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Vendored
+30
@@ -0,0 +1,30 @@
|
||||
{% import "lib/githubLinks.html" as github -%}
|
||||
{% import "lib/paramList.html" as params -%}
|
||||
{% extends 'layout/base.template.html' -%}
|
||||
|
||||
{% block body %}
|
||||
|
||||
|
||||
{% include "layout/_what-it-does.html" %}
|
||||
|
||||
{% include "layout/_security-notes.html" %}
|
||||
|
||||
{% include "layout/_deprecated-notes.html" %}
|
||||
|
||||
{% include "layout/_how-to-use.html" %}
|
||||
|
||||
{% include "layout/_ng-module.html" %}
|
||||
|
||||
<div layout="row" layout-xs="column" class="row-margin ng-cloak">
|
||||
<div flex="20" flex-xs="100">
|
||||
<h2 class="h2-api-docs">Description</h2>
|
||||
</div>
|
||||
<div class="code-links" flex="80" flex-xs="100">
|
||||
{%- if doc.description.length > 2 %}{$ doc.description | trimBlankLines | marked $}{% endif %}
|
||||
</div>
|
||||
</div>
|
||||
<p class="location-badge">
|
||||
exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} }
|
||||
defined in {$ github.githubViewLink(doc, versionInfo) $}
|
||||
</p>
|
||||
{% endblock %}
|
||||
+1
@@ -0,0 +1 @@
|
||||
{% extends 'interface.template.html' %}
|
||||
Vendored
+33
@@ -0,0 +1,33 @@
|
||||
{% import "lib/githubLinks.html" as github -%}
|
||||
{% import "lib/paramList.html" as params -%}
|
||||
{% extends 'layout/base.template.html' %}
|
||||
|
||||
{% block body %}
|
||||
|
||||
|
||||
{% 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">Variable Export<h2>
|
||||
</div>
|
||||
<div class="code-links" flex="80" flex-xs="100">
|
||||
<pre class="prettyprint no-bg">
|
||||
<code>
|
||||
export {$ doc.name $}
|
||||
</code>
|
||||
</pre>
|
||||
{%- if not doc.notYetDocumented %}{$ doc.description | trimBlankLines | marked $}{% endif %}
|
||||
</div>
|
||||
</div>
|
||||
<p class="location-badge">
|
||||
exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} }
|
||||
defined in {$ github.githubViewLink(doc, versionInfo) $}
|
||||
</p>
|
||||
{% endblock %}
|
||||
Reference in New Issue
Block a user