[libcamera-devel,v2,01/12] libcamera: ipa: Document the parameters of the IPA C configure function

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

Commit Message

Laurent Pinchart July 4, 2020, 12:52 a.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>
Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>
Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>
---
 src/libcamera/ipa_interface.cpp | 5 +++++
 1 file changed, 5 insertions(+)

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()
  */