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

Update/fix XML docs for generated types #44

Open
cremor opened this issue Jan 16, 2023 · 4 comments
Open

Update/fix XML docs for generated types #44

cremor opened this issue Jan 16, 2023 · 4 comments

Comments

@cremor
Copy link

cremor commented Jan 16, 2023

Rationale

The XML documentation of the generated types - at least the types which are directly used by developers - should match the documentation which is available on learn.microsoft.com and in the IDE when the "native" types are used.

I haven't checked all types, but I've found differences in:

  • CallerArgumentExpressionAttribute
    • class summary
    • class remarks
    • ctor paramter
    • property summary
  • Index
    • class summary
    • class remarks
    • various small differences in members
@0xced
Copy link
Contributor

0xced commented Nov 8, 2023

I guess this is somewhat linked to #88.

@gregsdennis
Copy link

For my use, I don't really care if the docs match the types. I have XML doc generation enabled in my libs, and I get warnings on any public code that doesn't have XML comments. I'd be happy with anything, even empty, but I agree that it should be whatever MS has.

@SimonCropp
Copy link

would adding #pragma warning disable to all the generated files suffice?

@gregsdennis
Copy link

That would solve my problem, sure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants