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.
This commit is contained in:
Peter Bacon Darwin
2015-11-13 16:34:57 +00:00
parent 489ffc9f97
commit dbc95b75af
10 changed files with 198 additions and 27 deletions
@@ -58,7 +58,6 @@ module.exports = new Package('angular.io', [basePackage, targetPackage, cheatshe
.config(function(readFilesProcessor, generateNavigationDoc, createOverviewDump) {
// Clear out unwanted processors
generateNavigationDoc.$enabled = false;
//createOverviewDump.$enabled = false;
})
@@ -47,7 +47,11 @@ p.location-badge.
code.
{$ doc.constructorDoc.name $}{$ paramList(doc.constructorDoc.parameters) | indent(8, false) | trim $}
:marked
{%- if doc.constructorDoc.notYetDocumented %}
*Not Yet Documented*
{% else %}
{$ doc.constructorDoc.description | indentForMarkdown(6) | replace('## Example', '') | replace('# Example', '') | trimBlankLines $}
{% endif -%}
{% endif -%}
{%- for member in doc.members %}{% if not member.internal %}
@@ -58,8 +62,11 @@ p.location-badge.
{$ member.name $}{$ paramList(member.parameters) | indent(8, false) | trim $}{$ returnType(member.returnType) $}
:marked
{%- if member.notYetDocumented %}
*Not Yet Documented*
{% else %}
{$ member.description | indentForMarkdown(6) | replace('## Example', '') | replace('# Example', '') | trimBlankLines $}
{% endif %}
{% endif %}{% endfor %}
{%- endif -%}
@@ -15,6 +15,9 @@ include ../../_util-fns
defined in {$ githubViewLink(doc) $}
:marked
{%- if doc.notYetDocumented %}
*Not Yet Documented*
{% else %}
{$ doc.description | indentForMarkdown(4) | trimBlankLines $}
{% endif %}
{% endblock %}
@@ -16,7 +16,7 @@ include ../../_util-fns
:marked
{%- if doc.notYetDocumented %}
### *Not Yet Documented*
*Not Yet Documented*
{% else %}
{$ doc.description | indentForMarkdown(4) | trimBlankLines $}
{% endif -%}