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/device_enumerator.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/device_enumerator.cpp')
| -rw-r--r-- | src/libcamera/device_enumerator.cpp | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/src/libcamera/device_enumerator.cpp b/src/libcamera/device_enumerator.cpp index 66819f07..58b81c35 100644 --- a/src/libcamera/device_enumerator.cpp +++ b/src/libcamera/device_enumerator.cpp @@ -178,7 +178,7 @@ DeviceEnumerator::~DeviceEnumerator() /** * \fn DeviceEnumerator::init() * \brief Initialize the enumerator - * \return 0 on success, or a negative error code otherwise + * \return 0 on success or a negative error code otherwise * \retval -EBUSY the enumerator has already been initialized * \retval -ENODEV the enumerator can't enumerate devices */ @@ -195,7 +195,7 @@ DeviceEnumerator::~DeviceEnumerator() * with a warning message logged, without returning an error. Only errors that * prevent enumeration altogether shall be fatal. * - * \return 0 on success, or a negative error code on fatal errors. + * \return 0 on success or a negative error code otherwise */ /** @@ -206,8 +206,7 @@ DeviceEnumerator::~DeviceEnumerator() * and look up device nodes associated with all entities. Store the media device * in the internal list for later matching with pipeline handlers. * - * \return 0 on success, or a negative error code if the media device can't be - * created or populated + * \return 0 on success or a negative error code otherwise */ int DeviceEnumerator::addDevice(const std::string &deviceNode) { |