honeymoose
/
angular-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
angular-cn/docs/links-package/index.js

13 lines
429 B
JavaScript
Raw Normal View History

chore(doc-gen): add link inline tags This commit enables links to other docs, such as classes and modules, via the `{@link CodeIdentifier}` style inline tag. Dgeni identifies what you are linking to by comparing the identifier to the aliases for each doc. If no alias matches the identifier then the dgeni run exits with a missing doc in link error. If more than one alias matches the identifier then dgeni exits with an ambiguous link error. In the future we could build in some heuristics for choosing a preferred doc when the link is ambiguous, such as choosing a public doc over a non-public doc; and choosing a code component that is in the same module as the doc where the link is found. Currently there are two aliases for each API component: its name and its identier. For example, if the `Directive` class is exported from `angular2/annotations`, so its aliases are 'Directive' and `angular2/annotations.Directive`. There is an issue in the non-public doc generation, which means that it does not yet have `{@link}` tags implemented. This is that when we re-export a code component, it gets cloned into another module. This means that a simple reference to the code component's name will always produce an ambiguous link. This can be fixed with a heuristic as described above. Meanwhile you can avoid this by always using the full id of the code component if it is being re-exported. Closes #1371 Closes #1421
2015-04-17 08:50:04 -04:00
var Package = require('dgeni').Package;
module.exports = new Package('links', [])
chore(doc-gen): generate docs for angular.io You can generate docs for comsumption by the angular.io website by running: ```bash gulp docs/angular.io ``` The generated docs can be found in `dist/angular.io`
2015-04-25 17:29:20 -04:00
.factory(require('./inline-tag-defs/link'))
chore(doc-gen): add link inline tags This commit enables links to other docs, such as classes and modules, via the `{@link CodeIdentifier}` style inline tag. Dgeni identifies what you are linking to by comparing the identifier to the aliases for each doc. If no alias matches the identifier then the dgeni run exits with a missing doc in link error. If more than one alias matches the identifier then dgeni exits with an ambiguous link error. In the future we could build in some heuristics for choosing a preferred doc when the link is ambiguous, such as choosing a public doc over a non-public doc; and choosing a code component that is in the same module as the doc where the link is found. Currently there are two aliases for each API component: its name and its identier. For example, if the `Directive` class is exported from `angular2/annotations`, so its aliases are 'Directive' and `angular2/annotations.Directive`. There is an issue in the non-public doc generation, which means that it does not yet have `{@link}` tags implemented. This is that when we re-export a code component, it gets cloned into another module. This means that a simple reference to the code component's name will always produce an ambiguous link. This can be fixed with a heuristic as described above. Meanwhile you can avoid this by always using the full id of the code component if it is being re-exported. Closes #1371 Closes #1421
2015-04-17 08:50:04 -04:00
.factory(require('dgeni-packages/ngdoc/services/getAliases'))
.factory(require('dgeni-packages/ngdoc/services/getDocFromAlias'))
chore(doc-gen): relax link matching
2015-05-15 10:50:58 -04:00
.factory(require('./services/getLinkInfo'))
chore(doc-gen): add link inline tags This commit enables links to other docs, such as classes and modules, via the `{@link CodeIdentifier}` style inline tag. Dgeni identifies what you are linking to by comparing the identifier to the aliases for each doc. If no alias matches the identifier then the dgeni run exits with a missing doc in link error. If more than one alias matches the identifier then dgeni exits with an ambiguous link error. In the future we could build in some heuristics for choosing a preferred doc when the link is ambiguous, such as choosing a public doc over a non-public doc; and choosing a code component that is in the same module as the doc where the link is found. Currently there are two aliases for each API component: its name and its identier. For example, if the `Directive` class is exported from `angular2/annotations`, so its aliases are 'Directive' and `angular2/annotations.Directive`. There is an issue in the non-public doc generation, which means that it does not yet have `{@link}` tags implemented. This is that when we re-export a code component, it gets cloned into another module. This means that a simple reference to the code component's name will always produce an ambiguous link. This can be fixed with a heuristic as described above. Meanwhile you can avoid this by always using the full id of the code component if it is being re-exported. Closes #1371 Closes #1421
2015-04-17 08:50:04 -04:00
.config(function(inlineTagProcessor, linkInlineTagDef) {
inlineTagProcessor.inlineTagDefinitions.push(linkInlineTagDef);
});