Commit Graph

2 Commits

Author SHA1 Message Date
Peter Bacon Darwin a98085e7eb api-builder: allow descriptions to be empty via the `@noDescription` tag
If a document description is empty then it is marked with the `notYetDocumented`
property. This change allows developers to tag a code item (export, member, etc)
as explicitly not needing a description.
2015-11-13 16:39:21 +00:00
Peter Bacon Darwin dbc95b75af 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:39:20 +00:00