This repository was archived by the owner on Dec 4, 2017. It is now read-only.
docs(api/dart): avoid duplicate entries and fix breadcrumbs #1945
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.
Currently two entries are generated for top-level library members like classes, and the main API page for these members has no-so-useful breadcrumbs. E.g., the main API page for
PipeMetadata
has breadcrumb:angular2 > angular2 > PipeMetadata
, vs. the proper breadcrumbangular2 > angular2.core > PipeMetadata
that appears on the second copy of the API page entry.TLDR; within the
angular2
package there is a top-level catch-all library of the same name the exports most of the contained libraries. This results in duplicate API page entries (one forangular2.foo
and one forangular2.some_sub_lib_id.foo
). Furthermore, all internal page links tofoo
go toangualr2.foo
so we loose breadcrumb information. This commit fixes the issue by hiding the top-levelangular2
library definition only for the purpose of running dartdoc.