Commit Graph

75 Commits

Author SHA1 Message Date
Peter Bacon Darwin 244e5673ab api-builder: filter out member docs
Since we are not rendering these independently of their containers
2015-11-13 16:39:21 +00:00
Peter Bacon Darwin 954a3827b7 api-builder: add simplified name to module docs 2015-11-13 16:39:21 +00:00
Peter Bacon Darwin 888f9ff8d8 api-builder: move templates into angular.io package 2015-11-13 16:39:21 +00: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 21feaf499f api-builder: deduce the type of a symbol from its initializer 2015-11-13 16:39:21 +00:00
Peter Bacon Darwin 229557dcb2 api-builder: move the `constructor` into its own section 2015-11-13 16:39:21 +00:00
Peter Bacon Darwin ec4d7b82a2 api-builder: don't show constructor if it is marked as `@internal` 2015-11-13 16:39:21 +00:00
Peter Bacon Darwin f84534a9e2 api-builder: include `exportAs` info in directive docs 2015-11-13 16:39:20 +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 489ffc9f97 api-builder: remove annotation block from directive docs 2015-11-13 16:38:58 +00:00
Peter Bacon Darwin 7239b52984 api-builder: remove unnecessary outputFolder config setting from angular.io-package
This is set in the gulpfile now
2015-11-13 16:38:58 +00:00
Peter Bacon Darwin ed3a4965e5 api-building: add `@syntax` tag to docs-package 2015-11-13 16:38:58 +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 0f61ea288f api-builder: fix jade whitespace issues in the API templates 2015-11-10 18:37:20 +00:00
Peter Bacon Darwin bc7a17c4f6 api-builder: remove unwanted whitespace from directive template 2015-11-10 11:37:06 +00:00
Peter Bacon Darwin fc617d5a67 api-builder: fix incorrect jasmine matcher in target package tests 2015-11-10 11:37:06 +00:00
Peter Bacon Darwin 93c187de2a api-builder: trim blank lines from the end of a text block too 2015-11-10 11:37:06 +00:00
Peter Bacon Darwin 66a7edd8cb api-builder: add cheatsheet-package to generate cheatsheet data
Closes #348
2015-11-10 11:37:05 +00:00
Peter Bacon Darwin b68ef96472 api-builder: add target package 2015-11-07 09:30:55 +00:00
Peter Bacon Darwin bc8a319f61 api-builder: move ngdoc stuff out from doc-package and into content package 2015-11-06 12:51:25 +00:00
Peter Bacon Darwin d08ebf4b9a api-builder: refactor app-data doc to use generic pathTemplates 2015-11-04 16:21:11 +00:00
Peter Bacon Darwin bdc647462e angular.io-package: fix up test to match new functionality 2015-11-04 11:20:47 +00:00
Peter Bacon Darwin 83fbe75980 refact(api-builder): move into `tools` folder 2015-11-04 11:20:46 +00:00
Peter Bacon Darwin ce298009e6 refact(doc-shredder): move into `tools` folder 2015-11-04 10:47:05 +00:00
Peter Bacon Darwin a06b98ba75 refact(example-zipper): move into `tools` folder 2015-11-04 10:00:12 +00:00