[libcamera-devel,1/2] libcamera: message: Document Message::SignalMessage

Message ID 20190715092939.15349-1-laurent.pinchart@ideasonboard.com
State Accepted
Commit 3e29a2d520c9cb8c7b290574bceaadcc107678fa
Headers show
Series
  • [libcamera-devel,1/2] libcamera: message: Document Message::SignalMessage
Related show

Commit Message

Laurent Pinchart July 15, 2019, 9:29 a.m. UTC
The SignalMessage type is undocumented. Fix it.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 src/libcamera/message.cpp | 2 ++
 1 file changed, 2 insertions(+)

Comments

Jacopo Mondi July 16, 2019, 7:38 a.m. UTC | #1
Hi Laurent,
   thanks for the patch

Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>

On Mon, Jul 15, 2019 at 12:29:38PM +0300, Laurent Pinchart wrote:
> The SignalMessage type is undocumented. Fix it.
>
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---
>  src/libcamera/message.cpp | 2 ++
>  1 file changed, 2 insertions(+)
>
> diff --git a/src/libcamera/message.cpp b/src/libcamera/message.cpp
> index 0580c1051622..9f22ad7fc0b0 100644
> --- a/src/libcamera/message.cpp
> +++ b/src/libcamera/message.cpp
> @@ -41,6 +41,8 @@ LOG_DEFINE_CATEGORY(Message)
>   * \brief The message type
>   * \var Message::None
>   * \brief Invalid message type
> + * \var Message::SignalMessage
> + * \brief Asynchronous signal delivery across threads
>   */
>
>  /**
> --
> Regards,
>
> Laurent Pinchart
>
> _______________________________________________
> libcamera-devel mailing list
> libcamera-devel@lists.libcamera.org
> https://lists.libcamera.org/listinfo/libcamera-devel

Patch

diff --git a/src/libcamera/message.cpp b/src/libcamera/message.cpp
index 0580c1051622..9f22ad7fc0b0 100644
--- a/src/libcamera/message.cpp
+++ b/src/libcamera/message.cpp
@@ -41,6 +41,8 @@  LOG_DEFINE_CATEGORY(Message)
  * \brief The message type
  * \var Message::None
  * \brief Invalid message type
+ * \var Message::SignalMessage
+ * \brief Asynchronous signal delivery across threads
  */
 
 /**