Uploaded image for project: 'C Driver'
  1. C Driver
  2. CDRIVER-2881

Remove comment blocks on public functions

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Open
    • Priority: Trivial - P5
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: docs, libbson, libmongoc
    • Labels:

      Description

      Per our documentation convention, we should only document public facing functions in one place.

      This helps prevents cases like this where we have multiple contradictory copies of a function's documentation.

      Let's do one big sweep of our public API:

      • transfer any useful info from comment blocks into the .rst doc page
      • remove those comment blocks

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              kevin.albertson Kevin Albertson
              Participants:
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: