Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Commit 113d257

Browse files
chore(docs): deprecation notices for methods and properties
Closes #15351
1 parent ca0f0fa commit 113d257

File tree

1 file changed

+28
-18
lines changed

1 file changed

+28
-18
lines changed

docs/config/templates/ngdoc/api/module.template.html

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,33 +5,41 @@ <h1>
55
{% if doc.title %}{$ doc.title | marked $}{% else %}{$ doc.name | code $}{% endif %}
66
</h1>
77

8-
{% if doc.name != 'ng' and doc.name != 'auto' %}
9-
<h2>Installation</h2>
8+
<h2>Installation</h2>
9+
{% if doc.installation or doc.installation == '' %}
10+
{$ doc.installation | marked $}
11+
{% else %}
1012

11-
<p>First include {$ doc.packageFile | code $} in your HTML:</p>
12-
13-
{% code %}
14-
<script src="angular.js"></script>
15-
<script src="{$ doc.packageFile $}"></script>
16-
{% endcode %}
17-
18-
<p>You can download this file from the following places:</p>
13+
<p>First, get the file:</p>
1914
<ul>
2015
<li>
21-
<a href="https://developers.google.com/speed/libraries/devguide#angularjs">Google CDN</a><br>
22-
e.g. {$ ("//ajax.googleapis.com/ajax/libs/angularjs/X.Y.Z/" + doc.packageFile) | code $}
16+
<a href="https://developers.google.com/speed/libraries/devguide#angularjs">Google CDN</a> e.g.
17+
{% code %}"//ajax.googleapis.com/ajax/libs/angularjs/X.Y.Z/{$ doc.packageFile $}"{% endcode %}
18+
</li>
19+
<li>
20+
<a href="https://www.npmjs.com/">NPM</a> e.g.
21+
{% code %}npm install {$ doc.packageName $}@X.Y.Z{% endcode %}
2322
</li>
2423
<li>
25-
<a href="http://bower.io">Bower</a><br>
26-
e.g. {% code %}bower install {$ doc.packageName $}@X.Y.Z{% endcode %}
24+
<a href="http://bower.io">Bower</a> e.g.
25+
{% code %}bower install {$ doc.packageName $}#X.Y.Z{% endcode %}
2726
</li>
2827
<li>
29-
<a href="http://code.angularjs.org/">code.angularjs.org</a><br>
30-
e.g. {% code %}"//code.angularjs.org/X.Y.Z/{$ doc.packageFile $}"{% endcode %}
28+
<a href="https://code.angularjs.org/">code.angularjs.org</a>
29+
(discouraged for production use) e.g.
30+
{% code %}"//code.angularjs.org/X.Y.Z/{$ doc.packageFile $}"{% endcode %}
3131
</li>
3232
</ul>
3333
<p>where X.Y.Z is the AngularJS version you are running.</p>
34-
<p>Then load the module in your application by adding it as a dependent module:</p>
34+
35+
<p>Then, include {$ doc.packageFile | code $} in your HTML:</p>
36+
37+
{% code %}
38+
<script src="path/to/angular.js"></script>
39+
<script src="path/to/{$ doc.packageFile $}"></script>
40+
{% endcode %}
41+
42+
<p>Finally, load the module in your application by adding it as a dependent module:</p>
3543
{% code %}
3644
angular.module('app', ['{$ doc.name $}']);
3745
{% endcode %}
@@ -51,7 +59,7 @@ <h2 id="known-issues">Known Issues</h2>
5159
<td>{$ issueDoc.id | link(issueDoc.name, issueDoc) $}</td>
5260
<td>
5361
{% for issue in issueDoc.knownIssues -%}
54-
{$ issue | marked $}
62+
{$ issue | marked $} {% if not loop.last %}<hr>{% endif %}
5563
{% endfor -%}
5664
</td>
5765
</tr>
@@ -61,6 +69,7 @@ <h2 id="known-issues">Known Issues</h2>
6169
{% endif %}
6270

6371

72+
{% if doc.componentGroups.length %}
6473
<div class="component-breakdown">
6574
<h2>Module Components</h2>
6675
{% for componentGroup in doc.componentGroups %}
@@ -81,6 +90,7 @@ <h3 class="component-heading" id="{$ componentGroup.groupType | dashCase $}">{$
8190
</div>
8291
{% endfor %}
8392
</div>
93+
{% endif %}
8494

8595
{% if doc.usage %}
8696
<h2>Usage</h2>

0 commit comments

Comments
 (0)