[api-documenter] Add support for @defaultValue in Markdown and Yaml documenters#5733
Open
colinaaa wants to merge 2 commits intomicrosoft:mainfrom
Open
[api-documenter] Add support for @defaultValue in Markdown and Yaml documenters#5733colinaaa wants to merge 2 commits intomicrosoft:mainfrom
colinaaa wants to merge 2 commits intomicrosoft:mainfrom
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
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.
Summary
From the perspective of an end user, the
@defaultValuetag on class properties, variables, methods, and functions was previously extracted byapi-extractorbut ignored byapi-documenter, resulting in missing default value documentation. This change adds the logic to bothMarkdownDocumenterandYamlDocumenterto extract and render the@defaultValuetag correctly.Fixes #4249
Details
_writeDefaultValueSectionto render a "Default Value" heading and block content. It is now called for Properties, PropertySignatures, Variables, TypeAliases, Methods, MethodSignatures, Constructors, ConstructSignatures, and Functions.customBlocksand serialized it toyamlItem.defaultValue.IYamlItem,typescript.schema.json, andISDPYamlFileto formally supportdefaultValue?: string, mapping it correctly through the UDP to SDP pipeline inToSdpConvertHelper.ts.DocClass1.tsto verify output generation across both Markdown and Yaml formats.How it was tested
Added
@defaultValue "Hello World"and@defaultValue 123to test fixtures inbuild-tests/api-documenter-test. Ranheft testand verified that the newly generated.snapsnapshots properly contain the "Default Value" headings in Markdown and thedefaultValuekeys in the DocFX YAML payloads.