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

Ensure all our public APIs have XML docs #4355

Open
Youssef1313 opened this issue Dec 16, 2024 · 0 comments
Open

Ensure all our public APIs have XML docs #4355

Youssef1313 opened this issue Dec 16, 2024 · 0 comments

Comments

@Youssef1313
Copy link
Member

Youssef1313 commented Dec 16, 2024

As an example:

https://github.com/microsoft/testfx/blob/b10bda33dc1682c4d6c8be903cdd9d2f52407564/src/Platform/Microsoft.Testing.Platform/OutputDevice/WarningMessageOutputDeviceData.cs

This doesn't have XML doc comment. We should fail the build when this happens. I think CS1591 is used for that but it's currently added to NoWarn. However, when I tried to remove this NoWarn locally, build still succeeds which is questionable.

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

1 participant