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

Consider retrieving property grid summaries and descriptions from XML documentation comments #1940

Open
glopesdev opened this issue Jul 29, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation proposal Request for a new feature

Comments

@glopesdev
Copy link
Member

glopesdev commented Jul 29, 2024

As the rate of production of XML documentation comments increases for standard library and third-party packages, we are getting close to the point where maintaining two sets of strings (one for property grid with DescriptionAttribute; and another with XML documentation comments) for every member of every package will become unsustainable.

It would be preferable to simply rely on XML documentation comments for everything, and retrieve them automatically by collecting the available XML documentation databases, together with a set of utilities for generating XPath queries. A similar strategy to how documentation URLs are extracted could be employed, by leveraging the bootstrapper context to retrieve operator package provenance, or alternatively simply probe the assembly location and look for a companion XML documentation file.

Lazy caching would almost definitely need to be considered to allow reusing documentation databases, and some kind of type converter mechanism on top of the property grid would also need to be developed to override the default mechanism using DescriptionAttribute.

@glopesdev glopesdev added documentation Improvements or additions to documentation proposal Request for a new feature labels Jul 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation proposal Request for a new feature
Projects
None yet
Development

No branches or pull requests

1 participant