Skip to content
This repository was archived by the owner on Dec 4, 2017. It is now read-only.

Commit 59c7679

Browse files
Eric Jimeneznaomiblack
Eric Jimenez
authored and
naomiblack
committed
docs(class, decorator, directive, function, var) improve doc styling
1 parent 269269a commit 59c7679

File tree

5 files changed

+49
-45
lines changed

5 files changed

+49
-45
lines changed

‎tools/api-builder/angular.io-package/templates/class.template.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
{% block body %}
66
include {$ relativePath(doc.path, '_util-fns') $}
77

8-
.div(layout="row" layout-xs="column" class="row-margin")
8+
.div(layout="row" layout-xs="column" class="row-margin ng-cloak")
99
div(flex="20" flex-xs="100")
1010
h2(class="h2-api-docs") What it does
1111
div(flex="80" flex-xs="100")
@@ -16,7 +16,7 @@
1616
*Not yet documented*
1717
{% endif %}
1818

19-
.div(layout="row" layout-xs="column" class="row-margin")
19+
.div(layout="row" layout-xs="column" class="row-margin ng-cloak")
2020
div(flex="20" flex-xs="100")
2121
h2(class="h2-api-docs") How to use
2222
div(flex="80" flex-xs="100")
@@ -27,7 +27,7 @@
2727
*Not yet documented*
2828
{% endif %}
2929

30-
.div(class="row-margin" layout="row" layout-xs="column")
30+
.div(layout="row" layout-xs="column" class="ng-cloak")
3131
div(flex="20" flex-xs="100")
3232
h2(class="h2-api-docs") Class Overview
3333
div(flex="80" flex-xs="100")
@@ -64,7 +64,7 @@
6464
{% block additional %}
6565
{% endblock %}
6666

67-
.div(class="row-margin" layout="row" layout-xs="column")
67+
.div(layout="row" layout-xs="column" class="row-margin ng-cloak")
6868
div(flex="20" flex-xs="100")
6969
h2(class="h2-api-docs") Class Description
7070
div(class="code-links" flex="80" flex-xs="100")
@@ -75,7 +75,7 @@
7575
*Not yet documented*
7676
{% endif %}
7777

78-
.div(layout="row" layout-xs="column" class="row-margin")
78+
.div(layout="row" layout-xs="column" class="row-margin ng-cloak")
7979
div(flex="20" flex-xs="100")
8080
h2(class="h2-api-docs") Class Export
8181
div(flex="80" flex-xs="100")
@@ -85,7 +85,7 @@
8585

8686
{%- if doc.decorators.length %}
8787
{% block annotations %}
88-
.div(layout="row" layout-xs="column" class="row-margin")
88+
.div(layout="row" layout-xs="column" class="row-margin ng-cloak")
8989
div(flex="20" flex-xs="100")
9090
h2(class="h2-api-docs") Annotations
9191
div(flex="80" flex-xs="100")
@@ -104,7 +104,7 @@
104104
{% endif %}
105105

106106
{%- if doc.constructorDoc and not doc.constructorDoc.internal %}
107-
.div(layout="row" layout-xs="column" class="row-margin")
107+
.div(layout="row" layout-xs="column" class="row-margin ng-cloak")
108108
div(flex="20" flex-xs="100")
109109
h2(class="h2-api-docs") Constructor
110110
div(flex="80" flex-xs="100")
@@ -121,7 +121,7 @@
121121
{% endif %}
122122

123123
{% if doc.statics.length %}
124-
.div(layout="row" layout-xs="column" class="row-margin")
124+
.div(layout="row" layout-xs="column" class="row-margin ng-cloak")
125125
div(flex="20" flex-xs="100")
126126
h2(class="h2-api-docs") Static Members
127127
div(class="code-links" flex="80" flex-xs="100")
@@ -145,7 +145,7 @@
145145
{% endif %}
146146

147147
{% if doc.members.length %}
148-
.div(layout="row" layout-xs="column" class="instance-members" class="row-margin")
148+
.div(layout="row" layout-xs="column" class="instance-members" class="row-margin ng-cloak")
149149
div(flex="20" flex-xs="100")
150150
h2(class="h2-api-docs") Class Details
151151
div(class="code-links" flex="80" flex-xs="100")

‎tools/api-builder/angular.io-package/templates/decorator.template.html

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,22 @@
44

55
{% block body %}
66
include {$ relativePath(doc.path, '_util-fns') $}
7-
.l-main-section
8-
h2(class="decorator export")
9-
pre.prettyprint
7+
8+
.div(layout="row" layout-xs="column" class="row-margin ng-cloak")
9+
div(flex="20" flex-xs="100")
10+
h2(class="h2-api-docs") Variable Export
11+
div(class="code-links" flex="80" flex-xs="100")
12+
pre.prettyprint.no-bg
1013
code.
1114
export {$ doc.name $}(options : {@link {$ doc.decoratorType $} {$ doc.decoratorType | escape $}}){$ returnType(doc.returnType) $}
15+
:marked
16+
{%- if doc.notYetDocumented %}
17+
*Not yet documented*
18+
{% else %}
19+
{$ doc.description | indentForMarkdown(6) | trimBlankLines $}
20+
{% endif %}
1221

13-
p.location-badge.
14-
exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} }
15-
defined in {$ githubViewLink(doc) $}
22+
p.location-badge.
23+
exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} } defined in {$ githubViewLink(doc) $}
1624

17-
:marked
18-
{%- if doc.notYetDocumented %}
19-
*Not yet documented*
20-
{% else %}
21-
{$ doc.description | indentForMarkdown(4) | trimBlankLines $}
22-
{% endif -%}
2325
{% endblock %}

‎tools/api-builder/angular.io-package/templates/directive.template.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
{% block additional -%}
99

1010
{%- if doc.directiveOptions.selector.split(',').length %}
11-
.div(layout="row" layout-xs="column" class="row-margin")
11+
.div(layout="row" layout-xs="column" class="row-margin ng-cloak")
1212
div(flex="20" flex-xs="100")
1313
h2(class="h2-api-docs") Selectors
1414
div(flex="80" flex-xs="100")
@@ -19,7 +19,7 @@
1919
{% endif %}
2020

2121
{% if doc.outputs %}
22-
.div(layout="row" layout-xs="column" class="row-margin")
22+
.div(layout="row" layout-xs="column" class="row-margin ng-cloak")
2323
div(flex="20" flex-xs="100")
2424
h2(class="h2-api-docs") Outputs
2525
div(flex="80" flex-xs="100")
@@ -34,7 +34,7 @@
3434
{% endif %}
3535

3636
{% if doc.inputs %}
37-
.div(layout="row" layout-xs="column" class="row-margin")
37+
.div(layout="row" layout-xs="column" class="row-margin ng-cloak")
3838
div(flex="20" flex-xs="100")
3939
h2(class="h2-api-docs") Inputs
4040
div(flex="80" flex-xs="100")
@@ -49,7 +49,7 @@
4949
{% endif %}
5050

5151
{%- if doc.directiveOptions.exportAs %}
52-
.div(layout="row" layout-xs="column" class="row-margin")
52+
.div(layout="row" layout-xs="column" class="row-margin ng-cloak")
5353
div(flex="20" flex-xs="100")
5454
h2(class="h2-api-docs") Exported as
5555
div(flex="80" flex-xs="100")

‎tools/api-builder/angular.io-package/templates/function.template.html

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,22 @@
44

55
{% block body %}
66
include {$ relativePath(doc.path, '_util-fns') $}
7-
.l-main-section
8-
h2(class="function export")
9-
pre.prettyprint
7+
8+
.div(layout="row" layout-xs="column" class="row-margin ng-cloak")
9+
div(flex="20" flex-xs="100")
10+
h2(class="h2-api-docs") Class Export
11+
div(class="code-links" flex="80" flex-xs="100")
12+
pre.prettyprint.no-bg
1013
code.
1114
export {$ doc.name $}{$ paramList(doc.parameters) | indent(8, true) | trim $}{$ returnType(doc.returnType) $}
15+
:marked
16+
{%- if doc.notYetDocumented %}
17+
*Not yet documented*
18+
{% else %}
19+
{$ doc.description | indentForMarkdown(6) | trimBlankLines $}
20+
{% endif %}
1221

13-
p.location-badge.
14-
exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} }
15-
defined in {$ githubViewLink(doc) $}
22+
p.location-badge.
23+
exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} } defined in {$ githubViewLink(doc) $}
1624

17-
:marked
18-
{%- if doc.notYetDocumented %}
19-
*Not Yet Documented*
20-
{% else %}
21-
{$ doc.description | indentForMarkdown(4) | trimBlankLines $}
22-
{% endif %}
2325
{% endblock %}

‎tools/api-builder/angular.io-package/templates/var.template.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,22 @@
55
{% block body %}
66
include {$ relativePath(doc.path, '_util-fns') $}
77

8-
.div(layout="row" layout-xs="column" class="row-margin")
8+
.div(layout="row" layout-xs="column" class="row-margin ng-cloak")
99
div(flex="20" flex-xs="100")
1010
h2(class="h2-api-docs") Variable Export
11-
div(flex="80" flex-xs="100")
11+
div(class="code-links" flex="80" flex-xs="100")
1212
pre.prettyprint.no-bg
1313
code.
1414
export {$ doc.name $}{$ returnType(doc.returnType) $}
15+
:marked
16+
{%- if doc.notYetDocumented %}
17+
*Not yet documented*
18+
{% else %}
19+
{$ doc.description | indentForMarkdown(6) | trimBlankLines $}
20+
{% endif %}
1521

1622
p.location-badge.
1723
exported from {@link {$ doc.moduleDoc.id $} {$doc.moduleDoc.id $} }
1824
defined in {$ githubViewLink(doc) $}
1925

20-
:marked
21-
{%- if doc.notYetDocumented %}
22-
*Not Yet Documented*
23-
{% else %}
24-
{$ doc.description | indentForMarkdown(2) | trimBlankLines $}
25-
{% endif -%}
2626
{% endblock %}

0 commit comments

Comments
 (0)