diff options
| author | Niklas Söderlund <niklas.soderlund@ragnatech.se> | 2019-02-26 01:21:22 +0100 |
|---|---|---|
| committer | Niklas Söderlund <niklas.soderlund@ragnatech.se> | 2019-02-27 17:36:30 +0100 |
| commit | acb56ebef833e0189f4d867c144363ef522ba740 (patch) | |
| tree | 744d20026ba14407f5f9924a8ec380dba957b5c9 /src/libcamera/camera.cpp | |
| parent | 9aceed70a2879802c7fe00ea2c0455ccd5c14f07 (diff) | |
libcamera: align the documentation for numeric error codes
Rapid growth of the library have resulted in slightly different wording
to document that a function returns 0 on success or a negative error
code otherwise. Align all different variations.
Signed-off-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>
Acked-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Diffstat (limited to 'src/libcamera/camera.cpp')
| -rw-r--r-- | src/libcamera/camera.cpp | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp index 6409d10f..3789732b 100644 --- a/src/libcamera/camera.cpp +++ b/src/libcamera/camera.cpp @@ -157,7 +157,7 @@ void Camera::disconnect() * * \todo Implement exclusive access across processes. * - * \return 0 on success or a negative error code on error. + * \return 0 on success or a negative error code otherwise */ int Camera::acquire() { @@ -235,7 +235,7 @@ Camera::streamConfiguration(std::vector<Stream *> &streams) * Exclusive access to the camera shall be ensured by a call to acquire() prior * to calling this function, otherwise an -EACCES error will be returned. * - * \return 0 on success or a negative error code on error. + * \return 0 on success or a negative error code otherwise * \retval -ENODEV The camera is not connected to any hardware * \retval -EACCES The user has not acquired exclusive access to the camera * \retval -EINVAL The configuration is not valid @@ -350,7 +350,7 @@ Request *Camera::createRequest() * Ownership of the request is transferred to the camera. It will be deleted * automatically after it completes. * - * \return 0 on success or a negative error code on error + * \return 0 on success or a negative error code otherwise */ int Camera::queueRequest(Request *request) { @@ -376,7 +376,7 @@ int Camera::queueRequest(Request *request) * can queue requests to the camera to process and return to the application * until the capture session is terminated with \a stop(). * - * \return 0 on success or a negative error code on error + * \return 0 on success or a negative error code otherwise */ int Camera::start() { @@ -395,7 +395,7 @@ int Camera::start() * This method stops capturing and processing requests immediately. All pending * requests are cancelled and complete synchronously in an error state. * - * \return 0 on success or a negative error code on error + * \return 0 on success or a negative error code otherwise */ int Camera::stop() { |