angular-cn/aio/tools/transforms/angular-api-package/processors
Pete Bacon Darwin cf0968f98e build(docs-infra): support hiding constructors of injectable classes (#24529)
Classes that are injectable often have constructors that should not be
called by the application developer. It is the responsibility of the
injector to instantiate the class and the constructor often contains
private implementation details that may need to change.

This commit removes constructors from the docs for API items that are
both:

a) Marked with an injectable decorator (e.g. Injectable, Directive,
Component, Pipe), and
b) Have no constructor description

This second rule allows the developer to override the removal if there
is something useful to say about the constructor.

Note that "normal" classes such as `angimations/HttpHeaders` do not have
their constructor removed, despite (at this time) having no description.

PR Close #24529
2018-06-26 10:58:11 -07:00
..
addMetadataAliases.js build(aio): do not store duplicate metadata aliases (#20512) 2017-11-21 22:28:16 -06:00
addMetadataAliases.spec.js build(aio): do not store duplicate metadata aliases (#20512) 2017-11-21 22:28:16 -06:00
addNotYetDocumentedProperty.js build(aio): fix `addNotYetDocumentedProperty` processor (#22770) 2018-03-15 11:37:31 -07:00
addNotYetDocumentedProperty.spec.js build(aio): fix `addNotYetDocumentedProperty` processor (#22770) 2018-03-15 11:37:31 -07:00
computeApiBreadCrumbs.js build(aio): compute breadcrums for all API doc types (#24000) 2018-06-13 16:47:40 -07:00
computeApiBreadCrumbs.spec.js build(aio): compute breadcrums for all API doc types (#24000) 2018-06-13 16:47:40 -07:00
computeSearchTitle.js build(aio): compute search title for certain API docs 2017-05-04 13:45:04 +01:00
computeSearchTitle.spec.js build(aio): compute search title for certain API docs 2017-05-04 13:45:04 +01:00
computeStability.js build(aio): compute stability and deprecate `@stable` tag (#22674) 2018-03-13 19:55:00 -07:00
computeStability.spec.js build(aio): compute stability and deprecate `@stable` tag (#22674) 2018-03-13 19:55:00 -07:00
convertPrivateClassesToInterfaces.js build(aio): refactor dgeni packages 2017-04-23 22:50:33 +01:00
extractDecoratedClasses.js build(aio): refactor dgeni packages 2017-04-23 22:50:33 +01:00
extractDecoratedClasses.spec.js build(aio): refactor dgeni packages 2017-04-23 22:50:33 +01:00
extractPipeParams.js build(aio): improve the API Pipe pages (#22702) 2018-03-14 14:21:11 -07:00
extractPipeParams.spec.js build(aio): improve the API Pipe pages (#22702) 2018-03-14 14:21:11 -07:00
filterContainedDocs.js build(aio): rearrange processors to ensure we catch all content errors (#24000) 2018-06-13 16:47:40 -07:00
filterPrivateDocs.js build(aio): rearrange processors to ensure we catch all content errors (#24000) 2018-06-13 16:47:40 -07:00
filterPrivateDocs.spec.js build(aio): rearrange processors to ensure we catch all content errors (#24000) 2018-06-13 16:47:40 -07:00
generateApiListDoc.js build(docs-infra): ensure stability is computed before the API list (#24356) 2018-06-08 13:33:32 -07:00
generateApiListDoc.spec.js build(docs-infra): ensure stability is computed before the API list (#24356) 2018-06-08 13:33:32 -07:00
markBarredODocsAsPrivate.js build(aio): refactor dgeni packages 2017-04-23 22:50:33 +01:00
markBarredODocsAsPrivate.spec.js build(aio): fix test description 2017-07-11 11:44:05 +01:00
matchUpDirectiveDecorators.js build(aio): fix matchUpDirectiveDecorators processor 2017-07-11 11:44:05 +01:00
matchUpDirectiveDecorators.spec.js build(aio): fix matchUpDirectiveDecorators processor 2017-07-11 11:44:05 +01:00
mergeDecoratorDocs.js build(aio): refactor the decorator doc processing (#24000) 2018-06-13 16:47:40 -07:00
mergeDecoratorDocs.spec.js build(aio): ensure the correct decorator properties are merged (#24289) 2018-06-06 10:23:47 -07:00
migrateLegacyJSDocTags.js build(aio): add processor to migrate legacy tags `@whatItDoes` and `@howToUse` (#22401) 2018-02-28 10:43:27 -08:00
migrateLegacyJSDocTags.spec.js build(aio): add processor to migrate legacy tags `@whatItDoes` and `@howToUse` (#22401) 2018-02-28 10:43:27 -08:00
processClassLikeMembers.js feat(aio): first pass API docs redesign (#21874) 2018-02-09 13:05:16 -08:00
processClassLikeMembers.spec.js style: typos fixed - https://github.com/vlajos/misspell-fixer (#22975) 2018-03-27 14:51:53 -04:00
removeInjectableConstructors.js build(docs-infra): support hiding constructors of injectable classes (#24529) 2018-06-26 10:58:11 -07:00
removeInjectableConstructors.spec.js build(docs-infra): support hiding constructors of injectable classes (#24529) 2018-06-26 10:58:11 -07:00
simplifyMemberAnchors.js build(aio): improve accuracy of code auto-linking (#22494) 2018-03-01 08:11:19 -08:00
simplifyMemberAnchors.spec.js build(aio): improve accuracy of code auto-linking (#22494) 2018-03-01 08:11:19 -08:00
splitDescription.js style: typos fixed - https://github.com/vlajos/misspell-fixer (#22975) 2018-03-27 14:51:53 -04:00
splitDescription.spec.js build(aio): split the description property in API docs (#22401) 2018-02-28 10:43:27 -08:00