Skip to content

Unsupress Documentation Warnings & Thoroughly Document Library #126

Description

@ColmBhandal

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

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions