Commit Graph

13 Commits

Author SHA1 Message Date
vsavkin b38939c7f4 temp disable docs merger 2016-09-14 14:05:38 -07:00
Peter Bacon Darwin 13878efca7 api-builder: show metadata details on decorator docs 2016-09-09 15:01:03 -07:00
Peter Bacon Darwin a2089c5b4f api-builder: render pipes with specialised template 2016-09-09 14:44:46 -07:00
Peter Bacon Darwin 40a1049d47 doc-gen(mergeDecoratorDocs): capture all the metadata docs
Iterate through the docs and merge all the of metadata docs
for each decorator doc into the decorator doc and remove it
so that it is not rendered in a page of its own
2016-09-09 14:44:46 -07:00
Patrice Chalin cc689ce980 chore(api doc gen): log 'no api docs' as info not warning
closes #1860
There are too many undocumented interfaces to consider lack of API docs
in a source file to be worth a warning. The original author even
questions whether there should be such a warning. It is now logged at
the `info` level.
2016-07-14 14:36:50 -07:00
Foxandxss 21d74d531a chore: update all packages to latest versions
closes #1607
2016-06-06 12:24:25 -07:00
Eric Jimenez 1ac2a42308 chore(not yet documented): remove placeholder to reduce noise 2016-04-27 12:55:27 -04:00
Eric Jimenez 5ea7738ad3 change class and directive template. 2016-04-16 03:17:47 -07:00
Peter Bacon Darwin c94ad87dd4 chore(doc-gen): add createDecoratorDocs processor
The createDecoratorDocs processor identifies docs of exports that actually
represent decorators and get useful information for them.

This commit also set up the rest of the generation to display these new
decorator docs with their own template and updates the API list so that
we can filter the docs by decorator docType.
2016-01-10 21:16:47 -08:00
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
Peter Bacon Darwin e86fde8dc9 chore(jade): upgrade to use `marked` filter
The `Transformers.markdown` (`:markdown`) filter is deprecated. This commit updates
the entire docs project to use the `jstransformer-marked` (`:marked') filter.
2015-11-10 18:37:53 +00:00
Peter Bacon Darwin 83fbe75980 refact(api-builder): move into `tools` folder 2015-11-04 11:20:46 +00:00