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
452e7e7729
chore(doc-gen): automatically update environment and version on the cheatsheet
...
Closes #515
2015-12-15 09:51:52 -08:00
05a272a116
refact(docs-app): move filtered API list into a directive
...
Each API index page now displays data from an `api-list.json` file found
locally to that page. This lets us have different API lists for TS, JS
and Dart.
2015-12-10 21:35:02 -08:00
f7b6d83422
docs(dgeni): add in missing barrel files
...
closes #465
2015-12-09 14:49:35 -08:00
326e1f7395
chore(doc-gen): upgrade to use TypeScript 1.7.3
2015-12-09 12:18:33 +00:00
46735ad925
chore(doc-gen): fix target-package tests
2015-12-09 11:51:52 +00:00
3ede7bfea9
chore(doc-gen): new syntax for cheatsheet items
2015-12-08 17:37:19 -08:00
8459a4dd5c
chore(doc-gen): allow dart cheatsheet to be generated
2015-12-08 17:31:53 -08:00
af105bb354
chore(doc-gen): remove unwanted console.log
2015-12-02 11:53:50 +00:00
3759d6e6db
WIP: fix up path issues
2015-12-01 20:43:20 -08:00
eb37614d68
chore(doc-gen): update modules to include API docs
...
The public exported modules have been reorganized
2015-12-01 20:43:20 -08:00
7e3e77778d
api-builder: fix indentation on "Not Yet Documented" message
2015-11-17 10:36:09 +00:00
bb170824ea
api-builder: fix indentation on "Not Yet Documented" message
2015-11-17 10:05:03 +00:00
c304aedb04
Revert "api-builder: add breadcrumbs links"
...
This reverts commit 10b87e8017
2015-11-16 23:10:18 -08:00
217c690781
api-builder: fix type-alias template so it doesn't break jade
...
The previous template was HTML rather than Jade and code blocks in the
content caused the Jade processing to crash.
See https://github.com/angular/angular/issues/4480
2015-11-15 21:36:20 +00:00
10b87e8017
api-builder: add breadcrumbs links
2015-11-13 16:39:21 +00:00
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
954a3827b7
api-builder: add simplified name to module docs
2015-11-13 16:39:21 +00:00
888f9ff8d8
api-builder: move templates into angular.io package
2015-11-13 16:39:21 +00:00
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
21feaf499f
api-builder: deduce the type of a symbol from its initializer
2015-11-13 16:39:21 +00:00
229557dcb2
api-builder: move the `constructor` into its own section
2015-11-13 16:39:21 +00:00
ec4d7b82a2
api-builder: don't show constructor if it is marked as `@internal`
2015-11-13 16:39:21 +00:00
f84534a9e2
api-builder: include `exportAs` info in directive docs
2015-11-13 16:39:20 +00:00
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
489ffc9f97
api-builder: remove annotation block from directive docs
2015-11-13 16:38:58 +00:00
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
ed3a4965e5
api-building: add `@syntax` tag to docs-package
2015-11-13 16:38:58 +00:00
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
0f61ea288f
api-builder: fix jade whitespace issues in the API templates
2015-11-10 18:37:20 +00:00
bc7a17c4f6
api-builder: remove unwanted whitespace from directive template
2015-11-10 11:37:06 +00:00
fc617d5a67
api-builder: fix incorrect jasmine matcher in target package tests
2015-11-10 11:37:06 +00:00
93c187de2a
api-builder: trim blank lines from the end of a text block too
2015-11-10 11:37:06 +00:00
66a7edd8cb
api-builder: add cheatsheet-package to generate cheatsheet data
...
Closes #348
2015-11-10 11:37:05 +00:00
b68ef96472
api-builder: add target package
2015-11-07 09:30:55 +00:00
bc8a319f61
api-builder: move ngdoc stuff out from doc-package and into content package
2015-11-06 12:51:25 +00:00
d08ebf4b9a
api-builder: refactor app-data doc to use generic pathTemplates
2015-11-04 16:21:11 +00:00
bdc647462e
angular.io-package: fix up test to match new functionality
2015-11-04 11:20:47 +00:00
83fbe75980
refact(api-builder): move into `tools` folder
2015-11-04 11:20:46 +00:00
Peter Bacon Darwin
Naomi Black