Commit Graph

118 Commits

Author SHA1 Message Date
Pete Bacon Darwin 5bb92f29a4 fix(api-builder): fix path to upgrade/static library (#3450)
This invalid path was causing the static upgrade
library to be missed from the API documentation.
2017-03-28 14:24:27 +02:00
Filipe Silva 338e9e9438 docs: update to Angular 4.0 (#3415) 2017-03-23 19:50:10 -07:00
Pete Bacon Darwin 0cc9ad2acd fix(api-builder): tighten up check for decorator (#3369) 2017-03-12 12:52:06 -07:00
William KOZA d6a91c6bb5 API(template class) : Add space after static keyword (#3131) 2017-02-09 09:42:19 -08:00
Pete Bacon Darwin 81bc9feca6 Fix display of heritage (#2792)
* style(matchUpDirectiveDecorators): fix linting errors

* fix(doc-gen/templates): ensure heritage is displayed
2016-12-14 11:17:37 -08:00
Patrice Chalin 5ea668c1da chore(dart): drop api and cheatsheet scripts and gulp tasks (#2970)
* chore(dart): drop the tools/dart-api-builder

* chore(gulp): remove Dart cheatsheet and api tasks

* chore(tools): remove tools/api-builder/dart-package

* chore(gulp): drop pub task
2016-12-14 17:33:31 +01:00
Jesus Rodriguez 2649647ecb chore: add upgrade/static to API reference 2016-11-05 00:37:47 +01:00
Jesús Rodríguez 693f6ae462 chore: rename Angular 2 to simply Angular (#2402) 2016-09-19 20:24:40 -07:00
Igor Minar 7ed5d08af2 fix ngModule tag, api-list and json encoding 2016-09-14 15:13:41 -07:00
Patrice Chalin 33398281a2 chore(api-builder): use Jade include rather than Harp partial 2016-09-14 14:06:14 -07:00
vsavkin b38939c7f4 temp disable docs merger 2016-09-14 14:05:38 -07:00
vsavkin ec72c8007e fix: merge the decorator data with the symbol 2016-09-14 14:05:38 -07:00
Peter Bacon Darwin 9c55afdfde fix(api-builder): pass versionInfo to macros
The update to dgeni-packages led to a breaking change in the Nunjucks
templates, where macros are now isolated from their calling site.

This means that we must pass the `versionInfo` object through to the
macro rather than expecting it to be in scope already.
2016-09-14 07:39:06 -07:00
Peter Bacon Darwin 40a1279fb9 chore(api-builder): add ngModule dgeni tag 2016-09-13 22:13:18 -07:00
Igor Minar 87981260e0 fix(api-builder): ignore all symbols starting with _ 2016-09-13 09:20:58 -07:00
Naomi Black 6180fd5137 dgeni(api-builder): hide private classes with extra underscores 2016-09-13 08:47:57 -07:00
Peter Bacon Darwin c3bb033cc1 fix(api-builder): escape double-quotes in JSON output 2016-09-13 15:29:01 +01:00
Igor Minar 9b0b1ae3fb fix(api-builder): prefix static members with 'static' 2016-09-12 11:12:39 -07:00
Igor Minar ed6be8316f refactor(api-builder): remove obsolete stuff 2016-09-12 11:12:39 -07:00
Igor Minar 1e9c0724c2 fix(api-builder): correctly import github and params helpers 2016-09-09 15:18:07 -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
Peter Bacon Darwin 8c7e2a1766 chore(dgeni-packages): update to use 0.15.2
This version includes the feature to hide members that
are marked private in TypeScript.
2016-09-09 14:41:36 -07:00
Peter Bacon Darwin 2c9e78c500 fix(api-builder/addJadeDataDocs): handle newlines better (#2296)
Closes #2294
2016-09-09 07:39:12 -07:00
Peter Bacon Darwin 672ba7f479 fix(api-builder/linkDocs): don't crash if a doc has no fileInfo (#2296)
Closes #2294
2016-09-09 07:38:59 -07:00
Igor Minar 08130d85df fix(api-builder): remove line number from the github source link
this info is not interesting to the reader.
2016-09-08 14:25:30 -07:00
Igor Minar d83d3bd0a0 fix(api-builder): add a custom template for interface
before we were using the template for class which is wrong
2016-09-08 14:25:30 -07:00
Igor Minar 62d6a51436 fix(api-builder): remove bogus 'class export' section from class template 2016-09-08 14:25:30 -07:00
Igor Minar 24db3d5b9e fix(api-builder): remove obsolete decorator type 2016-09-08 14:25:30 -07:00
Jesús Rodríguez e02f255e0a chore: add testing API back 2016-09-02 15:15:29 +02:00
Naomi Black 050ef863da dgeni(api-surface): exclude private symbols for rc6 2016-08-31 22:21:37 -07:00
Naomi Black c995de09bb dgeni(new-packages): add platform-webworker and platform-webworker-dynamic 2016-08-31 07:03:00 -07:00
Patrice Chalin 2fcda45161 chore(api): Dart API source folders renamed (#2181)
- angular2 dartdoc files will be in `doc/api`
- angular2 site examples will be in `example`
2016-08-24 13:54:04 -07:00
Patrice Chalin 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
Peter Bacon Darwin 2fb503dabf doc-gen: fix filterable API list
Closes #2054
2016-08-09 10:51:16 -07:00
Peter Bacon Darwin 63e0e6eaf6 doc-gen: ignore new private module 2016-08-06 07:18:23 +01:00
Eric Jimenez cece720f47 output an audit file to keep track of documentation progress on API 2016-07-28 13:44:07 -07:00
Eric Jimenez ca0acb6107 hide notes if none are found 2016-07-27 12:50:23 -04:00
Patrice Chalin 1bef20abc4 docs(api/dart): add support for generation and display (#1888)
Fixes #1880.
Supersedes #1593.
2016-07-15 14:10:12 -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
Peter Bacon Darwin 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
Patrice Chalin 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
Patrice Chalin 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
Foxandxss 8b05dd2726 chore: show new forms library via the api-builder
closes #1829
2016-07-05 23:35:12 -07:00
Patrice Chalin 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
Foxandxss d1e6a24987 chore: add support for multiline annotations in the API 2016-07-04 17:03:20 +02:00
Naomi Black 2480a91570 chore(api): remove internal compiler API from docgen
closes #1771
2016-06-28 11:37:53 -07:00
Peter Bacon Darwin 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
Peter Bacon Darwin c4e87d9b83 api-builder: fix jade formatting of indented constructor code
Closes #1662
2016-06-13 22:42:56 -07:00