diff options
| author | Kieran Bingham <kieran.bingham@ideasonboard.com> | 2020-02-11 11:09:59 +0000 |
|---|---|---|
| committer | Kieran Bingham <kieran.bingham@ideasonboard.com> | 2020-02-13 16:47:56 +0000 |
| commit | 5dc5fb2ac57ec7123215c82d10992cfbcddf34e9 (patch) | |
| tree | 54c6f78eeefeba172556354defa31f135d8cce3c | |
| parent | 52774fff56f8315c3f6a55940fa7099a8982eab8 (diff) | |
libcamera: Standardize on doxygen \return
Two occasions in the source utilise the Doxygen '\returns' alias for \return.
We use \return everywhere else in the code. Update the two occurences to match.
Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
| -rw-r--r-- | src/libcamera/geometry.cpp | 2 | ||||
| -rw-r--r-- | src/libcamera/utils.cpp | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/src/libcamera/geometry.cpp b/src/libcamera/geometry.cpp index 32b0faea..92c53f64 100644 --- a/src/libcamera/geometry.cpp +++ b/src/libcamera/geometry.cpp @@ -269,7 +269,7 @@ bool operator<(const Size &lhs, const Size &rhs) /** * \brief Test if a size is contained in the range * \param[in] size Size to check - * \returns True if \a size is contained in the range + * \return True if \a size is contained in the range */ bool SizeRange::contains(const Size &size) const { diff --git a/src/libcamera/utils.cpp b/src/libcamera/utils.cpp index 94bbb883..453e3b3b 100644 --- a/src/libcamera/utils.cpp +++ b/src/libcamera/utils.cpp @@ -55,7 +55,7 @@ const char *basename(const char *path) * avoid vulnerabilities that could occur if set-user-ID or set-group-ID * programs accidentally trust the environment. * - * \returns A pointer to the value in the environment or NULL if the requested + * \return A pointer to the value in the environment or NULL if the requested * environment variable doesn't exist or if secure execution is required. */ char *secure_getenv(const char *name) |