honeymoose/angular-cn
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
angular-cn/tools/api-builder/docs-package/templates/overview-dump.template.html

75 lines
1.6 KiB
HTML
Raw Normal View History

api-builder: improve "not yet documented" handling * All export members are now tagged if they have no documentation. * All exports are tagged if they and their members have no documentation. * The templates for these docs display the words "Not Yet Documented" if they are tagged. * The build creates a warning for each export that is not documented * The build generates a new file, `public/docs/ts/latest/api/overview-dump.html`, which lists all the modules, exports and members highlighting those that are not documented.
2015-11-13 16:34:57 +00:00
{% include "lib/githubLinks.html" -%}
Initial pass at moving api doc builder over to angular.io
2015-09-15 23:21:55 -07:00
{% include "lib/paramList.html" -%}
<!DOCTYPE html>
<html>
<head>
<title></title>
<style>
api-builder: improve "not yet documented" handling * All export members are now tagged if they have no documentation. * All exports are tagged if they and their members have no documentation. * The templates for these docs display the words "Not Yet Documented" if they are tagged. * The build creates a warning for each export that is not documented * The build generates a new file, `public/docs/ts/latest/api/overview-dump.html`, which lists all the modules, exports and members highlighting those that are not documented.
2015-11-13 16:34:57 +00:00
body {
max-width: 1000px;
}
Initial pass at moving api doc builder over to angular.io
2015-09-15 23:21:55 -07:00
h2 {
api-builder: improve "not yet documented" handling * All export members are now tagged if they have no documentation. * All exports are tagged if they and their members have no documentation. * The templates for these docs display the words "Not Yet Documented" if they are tagged. * The build creates a warning for each export that is not documented * The build generates a new file, `public/docs/ts/latest/api/overview-dump.html`, which lists all the modules, exports and members highlighting those that are not documented.
2015-11-13 16:34:57 +00:00
margin-top: 20px;
margin-bottom: 0;
border-bottom: solid 1px black;
Initial pass at moving api doc builder over to angular.io
2015-09-15 23:21:55 -07:00
}
h3 {
api-builder: improve "not yet documented" handling * All export members are now tagged if they have no documentation. * All exports are tagged if they and their members have no documentation. * The templates for these docs display the words "Not Yet Documented" if they are tagged. * The build creates a warning for each export that is not documented * The build generates a new file, `public/docs/ts/latest/api/overview-dump.html`, which lists all the modules, exports and members highlighting those that are not documented.
2015-11-13 16:34:57 +00:00
margin-top: 10px;
margin-bottom: 0;
padding-left: 20px;
Initial pass at moving api doc builder over to angular.io
2015-09-15 23:21:55 -07:00
}
h4 {
api-builder: improve "not yet documented" handling * All export members are now tagged if they have no documentation. * All exports are tagged if they and their members have no documentation. * The templates for these docs display the words "Not Yet Documented" if they are tagged. * The build creates a warning for each export that is not documented * The build generates a new file, `public/docs/ts/latest/api/overview-dump.html`, which lists all the modules, exports and members highlighting those that are not documented.
2015-11-13 16:34:57 +00:00
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;
Initial pass at moving api doc builder over to angular.io
2015-09-15 23:21:55 -07:00
}
</style>
</head>
<body>
api-builder: improve "not yet documented" handling * All export members are now tagged if they have no documentation. * All exports are tagged if they and their members have no documentation. * The templates for these docs display the words "Not Yet Documented" if they are tagged. * The build creates a warning for each export that is not documented * The build generates a new file, `public/docs/ts/latest/api/overview-dump.html`, which lists all the modules, exports and members highlighting those that are not documented.
2015-11-13 16:34:57 +00:00
<h1>Module Overview</h1>
Initial pass at moving api doc builder over to angular.io
2015-09-15 23:21:55 -07:00
{% for module in doc.modules %}
api-builder: improve "not yet documented" handling * All export members are now tagged if they have no documentation. * All exports are tagged if they and their members have no documentation. * The templates for these docs display the words "Not Yet Documented" if they are tagged. * The build creates a warning for each export that is not documented * The build generates a new file, `public/docs/ts/latest/api/overview-dump.html`, which lists all the modules, exports and members highlighting those that are not documented.
2015-11-13 16:34:57 +00:00
<h2>
<code>{$ module.id $}{%- if module.public %} (public){% endif %}</code>
</h2>
Initial pass at moving api doc builder over to angular.io
2015-09-15 23:21:55 -07:00
{% for export in module.exports %}
api-builder: improve "not yet documented" handling * All export members are now tagged if they have no documentation. * All exports are tagged if they and their members have no documentation. * The templates for these docs display the words "Not Yet Documented" if they are tagged. * The build creates a warning for each export that is not documented * The build generates a new file, `public/docs/ts/latest/api/overview-dump.html`, which lists all the modules, exports and members highlighting those that are not documented.
2015-11-13 16:34:57 +00:00
<h3 {% if export.notYetDocumented %}class="not-documented"{% endif %}>
<a href="{$ githubHref(export) $}">
<code>{$ export.docType $} {$ export.name $}</code>
</a>
</h3>
{%- if export.constructorDoc %}
<h4 {% if export.constructorDoc.notYetDocumented %}class="not-documented"{% endif %}>
<a href="{$ githubHref(export.constructorDoc) $}">
<code>{$ export.constructorDoc.name $}{$ paramList(export.constructorDoc.params) $}</code>
</a>
</h4>
Initial pass at moving api doc builder over to angular.io
2015-09-15 23:21:55 -07:00
{% endif -%}
{%- for member in export.members %}
api-builder: improve "not yet documented" handling * All export members are now tagged if they have no documentation. * All exports are tagged if they and their members have no documentation. * The templates for these docs display the words "Not Yet Documented" if they are tagged. * The build creates a warning for each export that is not documented * The build generates a new file, `public/docs/ts/latest/api/overview-dump.html`, which lists all the modules, exports and members highlighting those that are not documented.
2015-11-13 16:34:57 +00:00
<h4 {% if member.notYetDocumented %}class="not-documented"{% endif %}>
<a href="{$ githubHref(member) $}">
<code>{$ member.name $}{$ paramList(member.params) $}</code>
</a>
</h4>
Initial pass at moving api doc builder over to angular.io
2015-09-15 23:21:55 -07:00
{% endfor %}
{% endfor %}
{% endfor %}
</body>
</html>
Reference in New Issue Copy Permalink