honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(class, decorator, directive, function, var) improve doc styling

This commit is contained in:
Eric Jimenez 2016-04-25 17:28:45 -04:00 committed by Naomi Black
parent 269269a54d
commit 59c76790af
5 changed files with 49 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
tools/api-builder/angular.io-package/templates/class.template.html
View File

@ -5,7 +5,7 @@
{% block body %} {% block body %}
include {$ relativePath(doc.path, '_util-fns') $} include {$ relativePath(doc.path, '_util-fns') $}
.div(layout="row" layout-xs="column" class="row-margin") .div(layout="row" layout-xs="column" class="row-margin ng-cloak")
div(flex="20" flex-xs="100") div(flex="20" flex-xs="100")
h2(class="h2-api-docs") What it does h2(class="h2-api-docs") What it does
div(flex="80" flex-xs="100") div(flex="80" flex-xs="100")
@ -16,7 +16,7 @@ include {$ relativePath(doc.path, '_util-fns') $}
*Not yet documented* *Not yet documented*
{% endif %} {% endif %}
.div(layout="row" layout-xs="column" class="row-margin") .div(layout="row" layout-xs="column" class="row-margin ng-cloak")
div(flex="20" flex-xs="100") div(flex="20" flex-xs="100")
h2(class="h2-api-docs") How to use h2(class="h2-api-docs") How to use
div(flex="80" flex-xs="100") div(flex="80" flex-xs="100")
@ -27,7 +27,7 @@ include {$ relativePath(doc.path, '_util-fns') $}
*Not yet documented* *Not yet documented*
{% endif %} {% endif %}
.div(class="row-margin" layout="row" layout-xs="column") .div(layout="row" layout-xs="column" class="ng-cloak")
div(flex="20" flex-xs="100") div(flex="20" flex-xs="100")
h2(class="h2-api-docs") Class Overview h2(class="h2-api-docs") Class Overview
div(flex="80" flex-xs="100") div(flex="80" flex-xs="100")
@ -64,7 +64,7 @@ include {$ relativePath(doc.path, '_util-fns') $}
{% block additional %} {% block additional %}
{% endblock %} {% endblock %}
.div(class="row-margin" layout="row" layout-xs="column") .div(layout="row" layout-xs="column" class="row-margin ng-cloak")
div(flex="20" flex-xs="100") div(flex="20" flex-xs="100")
h2(class="h2-api-docs") Class Description h2(class="h2-api-docs") Class Description
div(class="code-links" flex="80" flex-xs="100") div(class="code-links" flex="80" flex-xs="100")
@ -75,7 +75,7 @@ include {$ relativePath(doc.path, '_util-fns') $}
*Not yet documented* *Not yet documented*
{% endif %} {% endif %}
.div(layout="row" layout-xs="column" class="row-margin") .div(layout="row" layout-xs="column" class="row-margin ng-cloak")
div(flex="20" flex-xs="100") div(flex="20" flex-xs="100")
h2(class="h2-api-docs") Class Export h2(class="h2-api-docs") Class Export
div(flex="80" flex-xs="100") div(flex="80" flex-xs="100")
@ -85,7 +85,7 @@ include {$ relativePath(doc.path, '_util-fns') $}
{%- if doc.decorators.length %} {%- if doc.decorators.length %}
{% block annotations %} {% block annotations %}
.div(layout="row" layout-xs="column" class="row-margin") .div(layout="row" layout-xs="column" class="row-margin ng-cloak")
div(flex="20" flex-xs="100") div(flex="20" flex-xs="100")
h2(class="h2-api-docs") Annotations h2(class="h2-api-docs") Annotations
div(flex="80" flex-xs="100") div(flex="80" flex-xs="100")
@ -104,7 +104,7 @@ include {$ relativePath(doc.path, '_util-fns') $}
{% endif %} {% endif %}
{%- if doc.constructorDoc and not doc.constructorDoc.internal %} {%- if doc.constructorDoc and not doc.constructorDoc.internal %}
.div(layout="row" layout-xs="column" class="row-margin") .div(layout="row" layout-xs="column" class="row-margin ng-cloak")
div(flex="20" flex-xs="100") div(flex="20" flex-xs="100")
h2(class="h2-api-docs") Constructor h2(class="h2-api-docs") Constructor
div(flex="80" flex-xs="100") div(flex="80" flex-xs="100")
@ -121,7 +121,7 @@ include {$ relativePath(doc.path, '_util-fns') $}
{% endif %} {% endif %}
{% if doc.statics.length %} {% if doc.statics.length %}
.div(layout="row" layout-xs="column" class="row-margin") .div(layout="row" layout-xs="column" class="row-margin ng-cloak")
div(flex="20" flex-xs="100") div(flex="20" flex-xs="100")
h2(class="h2-api-docs") Static Members h2(class="h2-api-docs") Static Members
div(class="code-links" flex="80" flex-xs="100") div(class="code-links" flex="80" flex-xs="100")
@ -145,7 +145,7 @@ include {$ relativePath(doc.path, '_util-fns') $}
{% endif %} {% endif %}
{% if doc.members.length %} {% if doc.members.length %}
.div(layout="row" layout-xs="column" class="instance-members" class="row-margin") .div(layout="row" layout-xs="column" class="instance-members" class="row-margin ng-cloak")
div(flex="20" flex-xs="100") div(flex="20" flex-xs="100")
h2(class="h2-api-docs") Class Details h2(class="h2-api-docs") Class Details
div(class="code-links" flex="80" flex-xs="100") div(class="code-links" flex="80" flex-xs="100")

26
tools/api-builder/angular.io-package/templates/decorator.template.html
View File

@ -4,20 +4,22 @@
{% block body %} {% block body %}
include {$ relativePath(doc.path, '_util-fns') $} include {$ relativePath(doc.path, '_util-fns') $}
.l-main-section
h2(class="decorator export") .div(layout="row" layout-xs="column" class="row-margin ng-cloak")
pre.prettyprint div(flex="20" flex-xs="100")
h2(class="h2-api-docs") Variable Export
div(class="code-links" flex="80" flex-xs="100")
pre.prettyprint.no-bg
code. code.
export {$ doc.name $}(options : {@link {$ doc.decoratorType $} {$ doc.decoratorType | escape $}}){$ returnType(doc.returnType) $} export {$ doc.name $}(options : {@link {$ doc.decoratorType $} {$ doc.decoratorType | escape $}}){$ returnType(doc.returnType) $}
p.location-badge.
exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} }
defined in {$ githubViewLink(doc) $}
:marked :marked
{%- if doc.notYetDocumented %} {%- if doc.notYetDocumented %}
*Not yet documented* *Not yet documented*
{% else %} {% else %}
{$ doc.description | indentForMarkdown(4) | trimBlankLines $} {$ doc.description | indentForMarkdown(6) | trimBlankLines $}
{% endif -%} {% endif %}
p.location-badge.
exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} } defined in {$ githubViewLink(doc) $}
{% endblock %} {% endblock %}

8
tools/api-builder/angular.io-package/templates/directive.template.html
View File

@ -8,7 +8,7 @@
{% block additional -%} {% block additional -%}
{%- if doc.directiveOptions.selector.split(',').length %} {%- if doc.directiveOptions.selector.split(',').length %}
.div(layout="row" layout-xs="column" class="row-margin") .div(layout="row" layout-xs="column" class="row-margin ng-cloak")
div(flex="20" flex-xs="100") div(flex="20" flex-xs="100")
h2(class="h2-api-docs") Selectors h2(class="h2-api-docs") Selectors
div(flex="80" flex-xs="100") div(flex="80" flex-xs="100")
@ -19,7 +19,7 @@
{% endif %} {% endif %}
{% if doc.outputs %} {% if doc.outputs %}
.div(layout="row" layout-xs="column" class="row-margin") .div(layout="row" layout-xs="column" class="row-margin ng-cloak")
div(flex="20" flex-xs="100") div(flex="20" flex-xs="100")
h2(class="h2-api-docs") Outputs h2(class="h2-api-docs") Outputs
div(flex="80" flex-xs="100") div(flex="80" flex-xs="100")
@ -34,7 +34,7 @@
{% endif %} {% endif %}
{% if doc.inputs %} {% if doc.inputs %}
.div(layout="row" layout-xs="column" class="row-margin") .div(layout="row" layout-xs="column" class="row-margin ng-cloak")
div(flex="20" flex-xs="100") div(flex="20" flex-xs="100")
h2(class="h2-api-docs") Inputs h2(class="h2-api-docs") Inputs
div(flex="80" flex-xs="100") div(flex="80" flex-xs="100")
@ -49,7 +49,7 @@
{% endif %} {% endif %}
{%- if doc.directiveOptions.exportAs %} {%- if doc.directiveOptions.exportAs %}
.div(layout="row" layout-xs="column" class="row-margin") .div(layout="row" layout-xs="column" class="row-margin ng-cloak")
div(flex="20" flex-xs="100") div(flex="20" flex-xs="100")
h2(class="h2-api-docs") Exported as h2(class="h2-api-docs") Exported as
div(flex="80" flex-xs="100") div(flex="80" flex-xs="100")

28
tools/api-builder/angular.io-package/templates/function.template.html
View File

@ -4,20 +4,22 @@
{% block body %} {% block body %}
include {$ relativePath(doc.path, '_util-fns') $} include {$ relativePath(doc.path, '_util-fns') $}
.l-main-section
h2(class="function export") .div(layout="row" layout-xs="column" class="row-margin ng-cloak")
pre.prettyprint div(flex="20" flex-xs="100")
h2(class="h2-api-docs") Class Export
div(class="code-links" flex="80" flex-xs="100")
pre.prettyprint.no-bg
code. code.
export {$ doc.name $}{$ paramList(doc.parameters) | indent(8, true) | trim $}{$ returnType(doc.returnType) $} export {$ doc.name $}{$ paramList(doc.parameters) | indent(8, true) | trim $}{$ returnType(doc.returnType) $}
p.location-badge.
exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} }
defined in {$ githubViewLink(doc) $}
:marked :marked
{%- if doc.notYetDocumented %} {%- if doc.notYetDocumented %}
*Not Yet Documented* *Not yet documented*
{% else %} {% else %}
{$ doc.description | indentForMarkdown(4) | trimBlankLines $} {$ doc.description | indentForMarkdown(6) | trimBlankLines $}
{% endif %} {% endif %}
p.location-badge.
exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} } defined in {$ githubViewLink(doc) $}
{% endblock %} {% endblock %}

16
tools/api-builder/angular.io-package/templates/var.template.html
View File

@ -5,22 +5,22 @@
{% block body %} {% block body %}
include {$ relativePath(doc.path, '_util-fns') $} include {$ relativePath(doc.path, '_util-fns') $}
.div(layout="row" layout-xs="column" class="row-margin") .div(layout="row" layout-xs="column" class="row-margin ng-cloak")
div(flex="20" flex-xs="100") div(flex="20" flex-xs="100")
h2(class="h2-api-docs") Variable Export h2(class="h2-api-docs") Variable Export
div(flex="80" flex-xs="100") div(class="code-links" flex="80" flex-xs="100")
pre.prettyprint.no-bg pre.prettyprint.no-bg
code. code.
export {$ doc.name $}{$ returnType(doc.returnType) $} export {$ doc.name $}{$ returnType(doc.returnType) $}
:marked
{%- if doc.notYetDocumented %}
*Not yet documented*
{% else %}
{$ doc.description | indentForMarkdown(6) | trimBlankLines $}
{% endif %}
p.location-badge. p.location-badge.
exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} } exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} }
defined in {$ githubViewLink(doc) $} defined in {$ githubViewLink(doc) $}
:marked
{%- if doc.notYetDocumented %}
*Not Yet Documented*
{% else %}
{$ doc.description | indentForMarkdown(2) | trimBlankLines $}
{% endif -%}
{% endblock %} {% endblock %}