Uploaded image for project: 'PHP Driver: Library'
  1. PHP Driver: Library
  2. PHPLIB-234

Document return values and exceptions for each API method

    XMLWordPrintableJSON

Details

    • Task
    • Status: Closed
    • Minor - P4
    • Resolution: Fixed
    • None
    • 1.1.0
    • Docs
    • None

    Description

      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.

      Attachments

        Issue Links

          Activity

            People

              jmikola@mongodb.com Jeremy Mikola
              jmikola@mongodb.com Jeremy Mikola
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: