Skip to content

Commit d83bddc

Browse files
committedApr 29, 2015
chore(docs): include attribute type in directive usage
Closes angular#11415
1 parent 5db6709 commit d83bddc

File tree

1 file changed

+60
-0
lines changed

1 file changed

+60
-0
lines changed
 

‎docs/config/templates/lib/macros.html

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
{% macro typeList(types) -%}
2+
{% for typeName in types %}<a href="" class="{$ typeName | typeClass $}">{$ typeName | escape $}</a>{% endfor %}
3+
{%- endmacro -%}
4+
5+
{%- macro paramTable(params) %}
6+
<table class="variables-matrix input-arguments">
7+
<thead>
8+
<tr>
9+
<th>Param</th>
10+
<th>Type</th>
11+
<th>Details</th>
12+
</tr>
13+
</thead>
14+
<tbody>
15+
{% for param in params %}
16+
<tr>
17+
<td>
18+
{$ param.name $}
19+
{% if param.alias %}| {$ param.alias $}{% endif %}
20+
{% if param.optional %}<div><em>(optional)</em></div>{% endif %}
21+
</td>
22+
<td>
23+
{$ typeList(param.typeList) $}
24+
</td>
25+
<td>
26+
{$ param.description | marked $}
27+
{% if param.defaultValue %}<p><em>(default: {$ param.defaultValue $})</em></p>{% endif %}
28+
</td>
29+
</tr>
30+
{% endfor %}
31+
</tbody>
32+
</table>
33+
{% endmacro -%}
34+
35+
36+
{%- macro directiveParam(name, type, join, sep) %}
37+
{%- if type.optional %}[{% endif -%}
38+
{$ name | dashCase $}{$ join $}{$ type.name $}{$ sep $}
39+
{%- if type.optional %}]{% endif -%}
40+
{% endmacro -%}
41+
42+
{%- macro functionSyntax(fn) %}
43+
{%- set sep = joiner(', ') -%}
44+
{% marked -%}
45+
`{$ fn.name $}({%- for param in fn.params %}{$ sep() $}
46+
{%- if param.type.optional %}[{% endif -%}
47+
{$ param.name $}
48+
{%- if param.type.optional %}]{% endif -%}
49+
{% endfor %});`
50+
{%- endmarked %}
51+
{% endmacro -%}
52+
53+
{%- macro typeInfo(fn) -%}
54+
<table class="variables-matrix return-arguments">
55+
<tr>
56+
<td>{$ typeList(fn.typeList) $}</td>
57+
<td>{$ fn.description | marked $}</td>
58+
</tr>
59+
</table>
60+
{%- endmacro -%}

0 commit comments

Comments
 (0)