From acb56ebef833e0189f4d867c144363ef522ba740 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Niklas=20S=C3=B6derlund?= Date: Tue, 26 Feb 2019 01:21:22 +0100 Subject: libcamera: align the documentation for numeric error codes MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Reviewed-by: Jacopo Mondi Acked-by: Laurent Pinchart --- src/libcamera/device_enumerator.cpp | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) (limited to 'src/libcamera/device_enumerator.cpp') 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) { -- cgit v1.2.1