X Tutup
Skip to content

fix(docs): export simple name and full name for doc alias #2462

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jeffbcross wants to merge 1 commit into from
Closed

fix(docs): export simple name and full name for doc alias #2462

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion docs/dgeni-package/processors/readTypeScriptModules.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,11 +139,23 @@ module.exports = function readTypeScriptModules(tsParser, readFilesProcessor, mo
}
});

/**
* Fixes issue where @link aliases in docs are referring to the token name (i.e. QueryList),
* but the name variable contains the token name plus generic information and heritage, (i.e.
* QueryList<T> extends List<T>). See https://github.com/angular/angular/issues/2452
*/
var exportAliasNames = [name];
var simpleAliasRegexp = /^([a-zA-Z0-9]+).*$/i;
var simpleNameMatch = simpleAliasRegexp.exec(name);
if (simpleNameMatch && simpleNameMatch.length > 1 && simpleNameMatch[1] !== name) {
exportAliasNames.push(simpleNameMatch[1]);
}

var exportDoc = {
docType: getExportDocType(exportSymbol),
name: name,
id: name,
aliases: [name],
aliases: exportAliasNames,
moduleDoc: moduleDoc,
content: getContent(exportSymbol),
fileInfo: getFileInfo(exportSymbol, basePath),
Expand Down
6 changes: 3 additions & 3 deletions modules/angular2/src/core/annotations_impl/annotations.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -512,7 +512,7 @@ export class Directive extends Injectable {
* For example, we could write a binding that updates the directive on structural changes, rather
* than on reference changes, as normally occurs in change detection.
*
* See {@link Pipe} and {@link pipes/keyValDiff} documentation for more details.
* See {@link Pipe} and {@link KeyValueChanges} documentation for more details.
*
* ```
* @Directive({
Expand Down Expand Up @@ -724,8 +724,8 @@ export class Directive extends Injectable {
/**
* Specifies a set of lifecycle hostListeners in which the directive participates.
*
* See {@link annotations/onChange}, {@link annotations/onDestroy},
* {@link annotations/onAllChangesDone} for details.
* See {@link /angular2/annotations/onChange}, {@link /angular2/annotations/onDestroy},
* {@link /angular2/annotations/onAllChangesDone} for details.
*/
lifecycle: List<LifecycleEvent>;

Expand Down
X Tutup