a4f3f3f81d
Now, one can add an `@alias` tag to API docs, which tells dgeni that this
API element (usually a `const`) is really just an alias for some API element
defined elsewhere.
Dgeni will then look up this API element and copy over the properties from
the alias to the current doc.
For example, we would like to privately export an Enum from `@angular/core`
but then publicly export this from `@angular/common`:
**packages/core/private_exports.ts**
```ts
/**
* Description of this document.
*/
export enum ɵSomeEnum { ... }
```
**packages/common/public_api.ts**
```ts
import {ɵSomeEnum} from '@angular/core';
/**
* @alias core/ɵSomeEnum
*/
export const SomeEnum = ɵSomeEnum;
```
In the generated docs there will be a page for `common/SomeEnum`, which
will be rendered as an enum, rather than a const, showing the description
extracted from the `core/ɵSomeEnum`.
---
The implementation of this feature required some refactoring of the other
processing:
1. Previously `ɵ` prefixed exports were not even considered.
2. Due to 1. some processors needed to have guards added to ignore such
private exports (`addMetadataAliases` and `checkContentRules`).
3. The processing of package pages had to be reworked (and split) so that
it picked up the aliased export docs after their alias proeprties had
been copied.
See FW-1207, FW-632, #29249
PR Close #29673
|
||
|---|---|---|
| .. | ||
| angular-api-package | ||
| angular-base-package | ||
| angular-content-package | ||
| angular.io-package | ||
| authors-package | ||
| cli-docs-package | ||
| content-package | ||
| examples-package | ||
| helpers | ||
| links-package | ||
| post-process-package | ||
| remark-package | ||
| target-package | ||
| templates | ||
| .eslintignore | ||
| .eslintrc.js | ||
| README.md | ||
| config.js | ||
| test.js | ||
README.md
Overview
All the content that is rendered by the AIO application, and some of its configuration files, are generated from source files by Dgeni. Dgeni is a general purpose documentation generation tool.
Markdown files in /aio/content, code comments in the core Angular source files and example files
are processed and transformed into files that are consumed by the AIO application.
Dgeni is configured by "packages", which contain services and processors. Some of these packages are
installed as node_modules from the dgeni-packages and
some are specific to the AIO project.
The project specific packages are stored in this folder (aio/tools/transforms).
If you are an author and want to know how to generate the documentation, the steps are outlined in the top level README.md.
Root packages
To run Dgeni, you must specify a root package, which acts as the entry point to the documentation
generation.
This root package, in turn requires a number of other packages, some are defined locally in the
tools/transforms folder, such as tools/transforms/cheatsheet-package and
tools/transforms/content-package, etc. And some are brought in from the dgeni-packages node
modules, such as jsdoc and nunjucks.
- The primary root package is defined in
tools/transforms/angular.io-package/index.js. This package is used to run a full generation of all the documentation. - There are also root packages defined in
tools/transforms/authors-package/*-package.js. These packages are used by the documentation authors when writing docs, since it allows them to run partial doc generation, which is not complete but is faster for quickly seeing changes to the document that you are working on.
Other packages
- angular-base-package
- angular-api-package
- angular-content-package
- content-package
- examples-package
- links-package
- post-process-package
- remark-package
- target-package
Templates
All the templates for the angular.io dgeni transformations are stoted in the tools/transforms/templates
folder. See the README.