[api-extractor] API Extractor 7 release branch #951
Merged
Conversation
This file contains 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
…unction parameters
…overhaul # Conflicts: # apps/api-extractor/package.json # common/config/rush/shrinkwrap.yaml
(cherry picked from commit 58a4300)
(cherry picked from commit 6700652) # Conflicts: # apps/api-extractor/src/api/Extractor.ts # apps/api-extractor/src/start.ts
(cherry picked from commit 1efb25c) # Conflicts: # apps/api-extractor/src/api/Extractor.ts
…iles belonging to the current project (which may not have been built yet) (cherry picked from commit 51fd48b) # Conflicts: # apps/api-extractor/src/ExtractorContext.ts # apps/api-extractor/src/generators/dtsRollup/DtsRollupGenerator.ts
(cherry picked from commit c28c261) # Conflicts: # apps/api-extractor/src/ExtractorContext.ts # apps/api-extractor/src/analyzer/PackageMetadataManager.ts # apps/api-extractor/src/generators/dtsRollup/DtsRollupGenerator.ts
(cherry picked from commit e97a5f0) # Conflicts: # apps/api-extractor/src/api/Extractor.ts # apps/api-extractor/src/start.ts
(cherry picked from commit 9c32be6)
…y aren't relevant to documentation
…numMember.initializerExcerpt
…erpt.embeddedExcerpts
[api-extractor] Support "extends" field in api-extractor.json config file (cherry picked from commit 54eee36) # Conflicts: # common/reviews/api/api-extractor.api.ts
[api-documenter] fix _getTypeNameWithDot and link implements and extends to uid (cherry picked from commit 8d0fcab) # Conflicts: # apps/api-documenter/src/yaml/YamlDocumenter.ts
…overhaul # Conflicts: # apps/api-documenter/src/yaml/YamlDocumenter.ts # apps/api-extractor/src/ExtractorContext.ts # apps/api-extractor/src/analyzer/AstSymbolTable.ts # apps/api-extractor/src/api/Extractor.ts # apps/api-extractor/src/ast/AstNamespace.ts # apps/api-extractor/src/ast/AstStructuredType.ts # apps/api-extractor/src/generators/ApiJsonGenerator.ts # apps/api-extractor/src/generators/dtsRollup/DtsRollupGenerator.ts # apps/api-extractor/src/generators/dtsRollup/PackageMetadataManager.ts # apps/api-extractor/src/start.ts # apps/api-extractor/tslint.json # build-tests/api-extractor-test-05/etc/yaml/api-extractor-test-05/docclass1.yml # common/config/rush/shrinkwrap.yaml # common/reviews/api/api-extractor.api.ts
…we're not quite ready to dogfood the 7.0.0 beta
octogonz
force-pushed
the
pgonzal/ae-overhaul
branch
from
b52c5da
to
1518121
Compare
…porarily rolled back
|
|
|
@octogonz is there documentation somewhere for proper syntax for |
|
@craigkovatch see here: microsoft/tsdoc#20 When this TSDoc issue reaches consensus, that will become the spec that we will expect API Extractor to implement. After AE7 ships, the docs at https://api-extractor.com/pages/tsdoc/syntax/ will be updated with a complete tag reference specific to API Extractor's flavor of TSDoc. |
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.
This is the release branch for the 7.0.0 release of API Extractor. This is a major breaking change.
Architectural changes:
MarkupElementJSON structure for representing rich textApiModelAPI for reading/writing the .api.json file format. This provides advanced querying functionality and eliminates common mistakes.DocItemclasses have been replaced withApiModelNew features:
@exampletagsSince this PR has too many commits for CodeFlow, please add PR comments to the temporary squashed version of this pull request: PR #952