Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: UseClrTypeNames: new option to indicate that the output must use the CLR type names instead of the language specific aliases #10072

Merged
merged 3 commits into from
Jul 9, 2024

Conversation

Patrick8639
Copy link
Contributor

The option can be set in docfx.jsonconfiguration file, under the metadata object.

If the option is not set or its value is false, docfx works as usual: the output uses the language aliases.
For example, in C#, it displays int.

If the option value is true, docfx output will use the CLR type names.
For example, in C#, it displays Int32.

…CLR type names instead of the language specific aliases.
@Patrick8639 Patrick8639 changed the title UseClrTypeNames: new option to indicate that the output must use the CLR type names instead of the language specific aliases feat: UseClrTypeNames: new option to indicate that the output must use the CLR type names instead of the language specific aliases Jul 8, 2024
@filzrev
Copy link
Contributor

filzrev commented Jul 9, 2024

@yufeih
Copy link
Contributor

yufeih commented Jul 9, 2024

Thank you @Patrick8639 ! I'll update and merge the other PR after this is in.

@yufeih yufeih merged commit 1bb332a into dotnet:main Jul 9, 2024
7 checks passed
@yufeih yufeih added the new-feature Makes the pull request to appear in "New Features" section of the next release note label Jul 9, 2024
@Patrick8639 Patrick8639 deleted the feat/useClrTypeNames branch July 12, 2024 09:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new-feature Makes the pull request to appear in "New Features" section of the next release note
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants