This repository was archived by the owner on Dec 4, 2017. It is now read-only.
[superseded] chore(api doc gen): reduce false positives #1846
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
As of this commit (and once angular/angular#9873 gets merged on the ng side), there are no more warnings issued when generating the API docs. To try it out yourself use either one of these commands: @wardbell @Foxandxss : ready for review. |
|
Oh, this PR is built atop (though it is independent of) #1833. It just means that #1833 should be merged in first. I kept #1833 because @petebacondarwin gave some feedback on it, and I didn't want to loose a trace of that. |
chalin
force-pushed
the
chalin-chore-api-doc-gen-0707
branch
from
7817f71 to
69d6c08
Compare
- Don't report ambiguous links for deprecated modules; instead resolve
them by default to their respective modules. E.g., `{@link NgControl}`
will resolve to the type in `@angular/common/src/forms-deprecated` when
referenced from with `forms-deprecated` and to the type in
`@angular/forms` when referenced within `forms`.
- Missing API docs are now reported at log-level 'info' rather than
'warn'.
- Don't warn about issues that are due to bug
angular/dgeni-packages#192.
chalin
force-pushed
the
chalin-chore-api-doc-gen-0707
branch
from
69d6c08 to
8e28098
Compare
Closed
chalin
changed the title
chalin
changed the title
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DO NOT MERGE. Superseded by #1849, #1860.
See Patrice comment below. He is keeping it open until he extracts all useful material.
Original description
them by default to their respective modules. E.g.,
{@link NgControl}will resolve to the type in
@angular/common/src/forms-deprecatedwhenreferenced from with
forms-deprecatedand to the type in@angular/formswhen referenced withinforms.Support "import x as y" dgeni-packages#192.