[libcamera-devel,8/8] libcamera: camera: Drop full stop from \return

Message ID 20200526142237.407557-9-jacopo@jmondi.org
State Superseded, archived
Delegated to: Jacopo Mondi
Headers show
Series
  • android: Implament format translation
Related show

Commit Message

Jacopo Mondi May 26, 2020, 2:22 p.m. UTC
We don't use full stops at the end of \return directives in Doxygen
documentation. Drop it.

Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>
---
 src/libcamera/camera.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Laurent Pinchart June 4, 2020, 2:14 a.m. UTC | #1
Hi Jacopo,

Thank you for the patch.

On Tue, May 26, 2020 at 04:22:37PM +0200, Jacopo Mondi wrote:
> We don't use full stops at the end of \return directives in Doxygen
> documentation. Drop it.
> 
> Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

> ---
>  src/libcamera/camera.cpp | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp
> index eac769a43964..dfc3d193bd2b 100644
> --- a/src/libcamera/camera.cpp
> +++ b/src/libcamera/camera.cpp
> @@ -664,7 +664,7 @@ const ControlList &Camera::properties()
>   *
>   * \context This function is \threadsafe.
>   *
> - * \return An array of all the camera's streams.
> + * \return An array of all the camera's streams
>   */
>  const std::set<Stream *> &Camera::streams() const
>  {

Patch

diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp
index eac769a43964..dfc3d193bd2b 100644
--- a/src/libcamera/camera.cpp
+++ b/src/libcamera/camera.cpp
@@ -664,7 +664,7 @@  const ControlList &Camera::properties()
  *
  * \context This function is \threadsafe.
  *
- * \return An array of all the camera's streams.
+ * \return An array of all the camera's streams
  */
 const std::set<Stream *> &Camera::streams() const
 {