[libcamera-devel,v1,1/9] libcamera: ipa: Document the parameters of the IPA C configure function

Message ID 20200628231934.29025-2-laurent.pinchart@ideasonboard.com
State Superseded
Headers show
Series
  • Support passing custom data to IPA configure()
Related show

Commit Message

Laurent Pinchart June 28, 2020, 11:19 p.m. UTC
The parameters to the configure() function part of the ipa_context_ops
are not documented. Fix that.

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

Comments

Niklas Söderlund June 29, 2020, 2:24 p.m. UTC | #1
Hi Laurent,

Thanks for your work.

On 2020-06-29 02:19:26 +0300, Laurent Pinchart wrote:
> The parameters to the configure() function part of the ipa_context_ops
> are not documented. Fix that.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>

> ---
>  src/libcamera/ipa_interface.cpp | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/src/libcamera/ipa_interface.cpp b/src/libcamera/ipa_interface.cpp
> index 69835e63ab46..ebe47e1233a5 100644
> --- a/src/libcamera/ipa_interface.cpp
> +++ b/src/libcamera/ipa_interface.cpp
> @@ -340,6 +340,11 @@
>   * \var ipa_context_ops::configure
>   * \brief Configure the IPA stream and sensor settings
>   * \param[in] ctx The IPA context
> + * \param[in] sensor_info Camera sensor information
> + * \param[in] streams Configuration of all active streams
> + * \param[in] num_streams The number of entries in the \a streams array
> + * \param[in] maps Controls provided by the pipeline entities
> + * \param[in] num_maps The number of entries in the \a maps array
>   *
>   * \sa libcamera::IPAInterface::configure()
>   */
> -- 
> Regards,
> 
> Laurent Pinchart
> 
> _______________________________________________
> libcamera-devel mailing list
> libcamera-devel@lists.libcamera.org
> https://lists.libcamera.org/listinfo/libcamera-devel
Jacopo Mondi June 30, 2020, 10:25 a.m. UTC | #2
Hi Laurent,

On Mon, Jun 29, 2020 at 02:19:26AM +0300, Laurent Pinchart wrote:
> The parameters to the configure() function part of the ipa_context_ops
> are not documented. Fix that.
>
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

No warning from doxygen, so I guess this part is not parsed.
Assuming that's intended
Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>

Thanks
  j
> ---
>  src/libcamera/ipa_interface.cpp | 5 +++++
>  1 file changed, 5 insertions(+)
>
> diff --git a/src/libcamera/ipa_interface.cpp b/src/libcamera/ipa_interface.cpp
> index 69835e63ab46..ebe47e1233a5 100644
> --- a/src/libcamera/ipa_interface.cpp
> +++ b/src/libcamera/ipa_interface.cpp
> @@ -340,6 +340,11 @@
>   * \var ipa_context_ops::configure
>   * \brief Configure the IPA stream and sensor settings
>   * \param[in] ctx The IPA context
> + * \param[in] sensor_info Camera sensor information
> + * \param[in] streams Configuration of all active streams
> + * \param[in] num_streams The number of entries in the \a streams array
> + * \param[in] maps Controls provided by the pipeline entities
> + * \param[in] num_maps The number of entries in the \a maps array
>   *
>   * \sa libcamera::IPAInterface::configure()
>   */
> --
> 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/ipa_interface.cpp b/src/libcamera/ipa_interface.cpp
index 69835e63ab46..ebe47e1233a5 100644
--- a/src/libcamera/ipa_interface.cpp
+++ b/src/libcamera/ipa_interface.cpp
@@ -340,6 +340,11 @@ 
  * \var ipa_context_ops::configure
  * \brief Configure the IPA stream and sensor settings
  * \param[in] ctx The IPA context
+ * \param[in] sensor_info Camera sensor information
+ * \param[in] streams Configuration of all active streams
+ * \param[in] num_streams The number of entries in the \a streams array
+ * \param[in] maps Controls provided by the pipeline entities
+ * \param[in] num_maps The number of entries in the \a maps array
  *
  * \sa libcamera::IPAInterface::configure()
  */