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

Unsupress Documentation Warnings & Thoroughly Document Library #126

Open
ColmBhandal opened this issue Jan 27, 2022 · 0 comments
Open

Unsupress Documentation Warnings & Thoroughly Document Library #126

ColmBhandal opened this issue Jan 27, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@ColmBhandal
Copy link
Owner

Requirement

Un-suppress the following warnings & fix all the errors that they generate (warnings are being promoted to errors by default in this project), in order of priority:

  1. 1573 - No param tag for some parameter
  2. 1591- Missing XML Comment for publicly visible type or member
  3. 1712 - No param tag for some type parameter

Note: this issue can be split into multiple issue if necessary to fix each warning one at a time.

Value Proposition

  1. Documenting the whole library will make it more user-friendly
  2. Un-suppressing those warnings will enforce documentation on all future public types/members
@ColmBhandal ColmBhandal added the enhancement New feature or request label Jan 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant