[api-extractor] Add an experimental new ApiItem.canonicalReference property #1406
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
octogonz
requested review from
Lincoded,
apostolisms,
halfnibble,
iclanton and
sachinjoseph
as code owners
octogonz
commented
Jul 20, 2019
octogonz
commented
Jul 20, 2019
octogonz
commented
Jul 20, 2019
build-tests/api-documenter-test/etc/api-documenter-test.api.json
Outdated
Show resolved
Hide resolved
octogonz
commented
Jul 20, 2019
build-tests/api-documenter-test/etc/api-documenter-test.api.json
Outdated
Show resolved
Hide resolved
…overloadIndex of 0 instead of 1
octogonz
commented
Jul 22, 2019
build-tests/api-documenter-test/etc/api-documenter-test.api.json
Outdated
Show resolved
Hide resolved
rbuckton
reviewed
Jul 22, 2019
Co-Authored-By: Ron Buckton <[email protected]>
…-new-canonical-references
octogonz
force-pushed
the
octogonz/ae-new-canonical-references
branch
from
96f1e6b to
6da8406
Compare
octogonz
force-pushed
the
octogonz/ae-new-canonical-references
branch
from
9a9d3e5 to
dec3e00
Compare
…clarationReference.parseComponent()
…-new-canonical-references
…-new-canonical-references # Conflicts: # common/config/rush/pnpm-lock.yaml
…larify that it is not intended to be a general purpose property setter
…ntryPoint will participate in the `ApiItem.canonicalReference` in the future
Vitalius1
approved these changes
Aug 8, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
As part of the work to support hyperlinks for types that appear in the documentation (PR #1337), we need to introduce a new API for building canonical references with the new notation that @rbuckton prototyped in microsoft/tsdoc#172.
This is PR sets up the
ApiItem.canonicalReferencefor this purpose. It is marked as@beta, but the values are written in the .api.json file format for informational purposes.