-
Notifications
You must be signed in to change notification settings - Fork 831
fix(GlobalStaticResources): add an exclude xml doc tag to the generated type definition #21679
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
base: master
Are you sure you want to change the base?
fix(GlobalStaticResources): add an exclude xml doc tag to the generated type definition #21679
Conversation
…ed type definition
for case of some docs creation tool except from docfx is used, that does not consider the exclude tag, this should do the trick.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR addresses issue #18616 by preventing the auto-generated GlobalStaticResources class from appearing in API documentation. The fix adds an XML documentation <exclude /> tag and an EditorBrowsable attribute to the generated type definition to ensure it's hidden from documentation tools and IDE intellisense.
Key Changes
- Added
<exclude />XML doc comment to suppress the type from DocFX-generated API documentation - Added
EditorBrowsable(EditorBrowsableState.Never)attribute as a fallback for non-DocFX documentation tools
|
🤖 Your WebAssembly Skia Sample App stage site is ready! Visit it here: https://unowasmprstaging.z20.web.core.windows.net/pr-21679/wasm-skia-net9/index.html |
|
🤖 Your Docs stage site is ready! Visit it here: https://unodocsprstaging.z13.web.core.windows.net/pr-21679/docs/index.html |
|
@MartinZikmund 🤔 if I read the log right, its looking for the files beeing produced, but all of them are listed in the end just not maybe in the order it seems to expect them? Is there something missing that needs to be done more? I included the type for now in my filterConfig.yml for my docfx build but would be cool if this wouldn't be required in the future 😁 |
…ion-GlobalStaticResources
|
🤖 Your WebAssembly Skia Sample App stage site is ready! Visit it here: https://unowasmprstaging.z20.web.core.windows.net/pr-21679/wasm-skia-net9/index.html |
|
|
GitHub Issue: closes #18616
PR Type:
What is the current behavior? 🤔
the public accessor level of the GlobalStaticResources class is resulting in publication of this generated type
What is the new behavior? 🚀
Refering to the docfx documentation:
the added tag should generally already work for excluding this type from the api docs
Also adding the EditorBrowsable Attribute, for the case that someone might not use docfx then another docs creation tool that might not consider the exclude tag, the attribute should serve as redundant backup
PR Checklist ✅
Please check if your PR fulfills the following requirements:
Screenshots Compare Test Runresults.Other information ℹ️