Skip to content

Conversation

@DevTKSS
Copy link
Contributor

@DevTKSS DevTKSS commented Oct 25, 2025

GitHub Issue: closes #18616

PR Type:

  • 🐞 Bugfix

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 <exclude /> documentation comment excludes the type or member on a per API basis using C# documentation comment

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:

Other information ℹ️

for case of some docs creation tool except from docfx is used, that does not consider the exclude tag, this should do the trick.
Copilot AI review requested due to automatic review settings October 25, 2025 13:42
Copy link
Contributor

Copilot AI left a 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

@github-actions github-actions bot added the area/code-generation Categorizes an issue or PR as relevant to code generation label Oct 25, 2025
@unodevops
Copy link
Contributor

🤖 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

@unodevops
Copy link
Contributor

🤖 Your Docs stage site is ready! Visit it here: https://unodocsprstaging.z13.web.core.windows.net/pr-21679/docs/index.html

@DevTKSS
Copy link
Contributor Author

DevTKSS commented Oct 26, 2025

@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?
I just implemented the points from the issue report at the position Jerome linked.

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 😁

@unodevops
Copy link
Contributor

🤖 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

@unodevops
Copy link
Contributor

⚠️⚠️ The build 182840 has failed on Uno.UI - CI.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/code-generation Categorizes an issue or PR as relevant to code generation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Annotate generated GlobalStaticResources class

2 participants