2fd162425d
chore(dart): api doc builder enhancements ( #2050 )
...
- #2049 , support ng.io doc relative links and code-regions
- Change dartdoc output folder to `docs/api` (from `doc/api`).
2016-08-10 10:36:23 -07:00
2fb503dabf
doc-gen: fix filterable API list
...
Closes #2054
2016-08-09 10:51:16 -07:00
63e0e6eaf6
doc-gen: ignore new private module
2016-08-06 07:18:23 +01:00
cece720f47
output an audit file to keep track of documentation progress on API
2016-07-28 13:44:07 -07:00
ca0acb6107
hide notes if none are found
2016-07-27 12:50:23 -04:00
1bef20abc4
docs(api/dart): add support for generation and display ( #1888 )
...
Fixes #1880 .
Supersedes #1593 .
2016-07-15 14:10:12 -07:00
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
285ecf495f
chore(api-builder): add configurable link disambuators & put to work
...
closes #1852
Add configurable link disambuators
Add a service to disambiguate docs by module
Add a service to disambiguate docs that are deprecated
2016-07-14 14:33:55 -07:00
4da23bfe57
chore(api-builder): linkDevGuide -> linkDocs;linkDocs can default the lang
...
closes #1849
1) Rename linkDevGuide to linkDocs
Rename the specialized API docs `@linkDevGuide` tag to `@linkDocs`
since it is meant to be used to refer to all angular.io docs, not just
the developer guide.
2) let linkDocs links resolve to proper language
The old linkDevGuide required URIs to be given in the form
'ts/latest/guide/architecture' which forced all language versions of
the API pages to refer to the ts versions of the doc pages they linked
to.
This PR fixes that problem. URIs are now given in the form
'guide/architecture' and then rendered properly for each language. Of
course, when needed, it is still possible to give a language specific
URI.
chore(api-builder): minor code cleanup
2016-07-14 14:30:26 -07:00
86f82124d4
chore: dgeni tag defintions for ts2dart tags
...
closes #1833
New `dgeni` tag definitions for `ts2dart` tags which are currently
causing spurious warnings when generating API docs.
2016-07-11 20:14:21 -07:00
8b05dd2726
chore: show new forms library via the api-builder
...
closes #1829
2016-07-05 23:35:12 -07:00
67ee007fb0
chore(docs build): add flag to control log output level
...
closes #1823
Gulp targets like `check-deploy` and `serve-and-sync-devguide` are
quite verbose. This PR allows the `dgeni` logging level to be
controlled using the `--dgeni-log` flag. E.g., use `--dgen-log="error"`
to see only errors.
Also sets log level to "error" when gulp is silent
and log level for createShredMapPackage
2016-07-05 23:14:43 -07:00
d1e6a24987
chore: add support for multiline annotations in the API
2016-07-04 17:03:20 +02:00
2480a91570
chore(api): remove internal compiler API from docgen
...
closes #1771
2016-06-28 11:37:53 -07:00
7ee6e63a6f
api-builder: ignore additional platform browser private exports
...
These exports should not be part of the docs and
cause the doc-gen to fail.
Closes #1667
2016-06-15 08:31:30 +01:00
c4e87d9b83
api-builder: fix jade formatting of indented constructor code
...
Closes #1662
2016-06-13 22:42:56 -07:00
21d74d531a
chore: update all packages to latest versions
...
closes #1607
2016-06-06 12:24:25 -07:00
1324085c0c
feat(api docs): use partials for api docs. Implement deprecated and security notes section
2016-06-02 18:44:32 -07:00
16dccb6a6b
api-builder: consolidate readTypescriptProcessor configuration
...
closes #1440
2016-05-19 19:16:49 -07:00
0cb0bd7949
api-builder: fix class github link formatting
2016-05-19 19:16:24 -07:00
a42f3bf085
api-builder: fix githublinks
...
Closes #1435
Closes #1433
2016-05-19 19:16:24 -07:00
621bc31c61
feat(no index): remove index from api list, it is unnecessary additional information from dgeni
2016-05-12 17:49:16 -07:00
b5d2973163
feat(security badge): add a security badge to api docs. Only appears if @security is present in angular2
2016-05-12 17:48:54 -07:00
92ca0f3a9f
api-builder: add project specific typescript configuration
2016-05-12 03:40:57 -07:00
ac583748d1
api-builder: update to dgeni-packages 0.12.0 - factoring out the typescript package
2016-05-12 03:40:57 -07:00
d26461024c
feat(dgeni audit): add more keys to the api-list, this makes it easier to see changes across the api
2016-05-11 19:46:23 -07:00
8a29e502d3
chore(api): hide another private function
2016-05-03 18:48:09 -07:00
d442b30a68
chore(dgeni): update dgeni to serve old and new router
2016-05-02 17:42:05 -07:00
acc5233671
chore(dgeni): update dgeni to handle repackaging changes
2016-05-02 13:00:06 -07:00
b89647add4
chore(dgeni): fix missing apis in the master list
2016-04-29 17:20:59 -07:00
e91b4254de
docs(dgeni): fix Location-class missing from API list
2016-04-28 19:21:26 -07:00
1ac2a42308
chore(not yet documented): remove placeholder to reduce noise
2016-04-27 12:55:27 -04:00
59c76790af
docs(class, decorator, directive, function, var) improve doc styling
2016-04-25 16:58:03 -07:00
8f158f2241
docs(sidenav reorg): remove glossary and cheatsheet from REFERENCE. Move glossary to BASICS. Rename REFERENCE to API REFERENCE
2016-04-25 14:10:57 -07:00
9787a9ffb8
docs(static methods): fix style of static methods in api doc. anchoring works now
2016-04-22 17:13:05 -04:00
baf84a48e8
docs(static methods): fix style of static methods in api doc. anchoring works now
2016-04-22 17:03:34 -04:00
c932eec801
docs(code color fix): restored old color for code in parts that are not the api doc, use the same styling for all links in entire site
2016-04-21 12:03:12 -04:00
3dd114d0df
docs(class overview): list instance and static members with in-page hyperlinks. Also link constructor when present. Focus member on click. Badges look better in viewports of 600px or less
2016-04-20 13:14:18 -07:00
c934fb704f
docs(badges): add badges in hero to identify doc type to viewer, and stability. Stylize var.template for new api style docs. Add stable, experimental, docsNotRequired tagdef in dgeni
2016-04-19 20:49:48 -07:00
5ea7738ad3
change class and directive template.
2016-04-16 03:17:47 -07:00
d6d46076b7
fix(api-builder): add missing git package dependency
...
This was causing the api-builder tests to fail
2016-04-01 21:26:03 +01:00
fa4b597614
Add additional tags to the angular.io dgeni package for the new api doc style proposal.
...
Closes #1030
2016-04-01 17:37:21 +01:00
9e43a4f425
dgeni(upgrade): add upgrade which was missing from api docs
2016-02-10 15:04:09 -08:00
12e989da08
chore(doc-gen): include static members in the class template
...
Closes #761
2016-01-28 10:51:54 +00:00
e20f191429
fix(directives): remove dashCase pipe
2016-01-22 18:49:03 -08:00
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
Patrice Chalin
Peter Bacon Darwin
Eric Jimenez
Patrice Chalin
Foxandxss
Naomi Black
Eric Jimenez
Sebastian Müller