Document return values and exceptions for each API method

XMLWordPrintableJSON

    • Type: Task
    • Resolution: Done
    • Priority: Minor - P4
    • 1.1.0
    • Affects Version/s: None
    • Component/s: Docs
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None

      Current documentation uses :returns: for documenting return values. We'd prefer to have separate headings for "Errors/Exceptions" and "Return Values", as is done in the PHP.net documentation.

      Incorporating PHPLIB-82 into this task: Users should be aware that any operation that entails server selection or execution through the driver may result in a driver RuntimeException. We should settle on a clear way to document this without copy-pasting @throw annotations throughout the code base.

              Assignee:
              Jeremy Mikola
              Reporter:
              Jeremy Mikola
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: