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
- duplicates
-
PHPLIB-214 Document exceptions thrown by library methods
-
- Closed
-
-
PHPLIB-82 Document common exceptions from selectServer() and driver execute methods
-
- Closed
-
- is depended on by
-
-
- Closed
-
- links to