Uploaded image for project: 'Couchbase .NET client library'
  1. Couchbase .NET client library
  2. NCBC-1281

Suppress XML Comment Missing (CS1591) build warnings

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Closed
    • Priority: Major
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: 2.4.1
    • Component/s: None
    • Labels:
      None

      Description

      The current build configuration generates compilation warnings for public methods and properties that do not have documentation.

      The warning looks like:
      Missing XML comment for publicly visible type or member 'MultiplexingIOService.ExecuteAsync<T>(IOperation<T>, IConnection)'
      Warning number: CS1591

      I've created ticket NCBC-1282 to work on improving the XML documentation, however in the meantime to help clean up the AppVeyor output we should suppress warning number CS1591 for our projects.

        Attachments

        For Gerrit Dashboard: NCBC-1281
        # Subject Branch Project Status CR V

          Activity

          Hide
          mike.goldsmith Michael Goldsmith added a comment -

          Reopening until commit is reviewed and merged.

          Show
          mike.goldsmith Michael Goldsmith added a comment - Reopening until commit is reviewed and merged.

            People

            • Assignee:
              mike.goldsmith Michael Goldsmith
              Reporter:
              mike.goldsmith Michael Goldsmith
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Gerrit Reviews

                There are no open Gerrit changes

                  PagerDuty

                  Error rendering 'com.pagerduty.jira-server-plugin:PagerDuty'. Please contact your Jira administrators.