| Message ID | 20200211111011.18499-1-kieran.bingham@ideasonboard.com |
|---|---|
| State | Accepted |
| Commit | 5dc5fb2ac57ec7123215c82d10992cfbcddf34e9 |
| Headers | show |
| Series |
|
| Related | show |
Hi Kieran, Thank you for the patch. On Tue, Feb 11, 2020 at 11:10:11AM +0000, Kieran Bingham wrote: > 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> > --- > src/libcamera/geometry.cpp | 2 +- > 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 32b0faeadc63..92c53f64a58b 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 fc6a174d80f2..f5d4b10f34b5 100644 > --- a/src/libcamera/utils.cpp > +++ b/src/libcamera/utils.cpp > @@ -57,7 +57,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)
diff --git a/src/libcamera/geometry.cpp b/src/libcamera/geometry.cpp index 32b0faeadc63..92c53f64a58b 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 fc6a174d80f2..f5d4b10f34b5 100644 --- a/src/libcamera/utils.cpp +++ b/src/libcamera/utils.cpp @@ -57,7 +57,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)
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> --- src/libcamera/geometry.cpp | 2 +- src/libcamera/utils.cpp | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)