[libcamera-devel] [PATCH v4 13/32] ipa: rkisp1: Sort documentation of the IPA context

[Jacopo Mondi]

Hi Laurent

On Thu, Sep 08, 2022 at 04:41:41AM +0300, Laurent Pinchart via libcamera-devel wrote:
> The documentation of the IPA context structures is separate from the
> documentation of the structure members. Sort the documentation block to
> group members with their structure.
>
> Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>

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


> ---
>  src/ipa/rkisp1/ipa_context.cpp | 62 +++++++++++++++++-----------------
>  1 file changed, 31 insertions(+), 31 deletions(-)
>
> diff --git a/src/ipa/rkisp1/ipa_context.cpp b/src/ipa/rkisp1/ipa_context.cpp
> index f64af732260c..cc66bc70ac44 100644
> --- a/src/ipa/rkisp1/ipa_context.cpp
> +++ b/src/ipa/rkisp1/ipa_context.cpp
> @@ -24,37 +24,6 @@ namespace libcamera::ipa::rkisp1 {
>   * may also be updated in the start() operation.
>   */
>
> -/**
> - * \struct IPAFrameContext
> - * \brief Per-frame context for algorithms
> - *
> - * The frame context stores data specific to a single frame processed by the
> - * IPA. Each frame processed by the IPA has a context associated with it,
> - * accessible through the IPAContext structure.
> - *
> - * \todo Detail how to access contexts for a particular frame
> - *
> - * Each of the fields in the frame context belongs to either a specific
> - * algorithm, or to the top-level IPA module. A field may be read by any
> - * algorithm, but should only be written by its owner.
> - */
> -
> -/**
> - * \struct IPAContext
> - * \brief Global IPA context data shared between all algorithms
> - *
> - * \var IPAContext::configuration
> - * \brief The IPA session configuration, immutable during the session
> - *
> - * \var IPAContext::frameContext
> - * \brief The frame context for the frame being processed
> - *
> - * \todo While the frame context is supposed to be per-frame, this
> - * single frame context stores data related to both the current frame
> - * and the previous frames, with fields being updated as the algorithms
> - * are run. This needs to be turned into real per-frame data storage.
> - */
> -
>  /**
>   * \var IPASessionConfiguration::agc
>   * \brief AGC parameters configuration of the IPA
> @@ -115,6 +84,21 @@ namespace libcamera::ipa::rkisp1 {
>   * \brief Sensor output resolution
>   */
>
> +/**
> + * \struct IPAFrameContext
> + * \brief Per-frame context for algorithms
> + *
> + * The frame context stores data specific to a single frame processed by the
> + * IPA. Each frame processed by the IPA has a context associated with it,
> + * accessible through the IPAContext structure.
> + *
> + * \todo Detail how to access contexts for a particular frame
> + *
> + * Each of the fields in the frame context belongs to either a specific
> + * algorithm, or to the top-level IPA module. A field may be read by any
> + * algorithm, but should only be written by its owner.
> + */
> +
>  /**
>   * \var IPAFrameContext::agc
>   * \brief Context for the Automatic Gain Control algorithm
> @@ -216,4 +200,20 @@ namespace libcamera::ipa::rkisp1 {
>   * Algorithm::prepare() function of all algorithms.
>   */
>
> +/**
> + * \struct IPAContext
> + * \brief Global IPA context data shared between all algorithms
> + *
> + * \var IPAContext::configuration
> + * \brief The IPA session configuration, immutable during the session
> + *
> + * \var IPAContext::frameContext
> + * \brief The frame context for the frame being processed
> + *
> + * \todo While the frame context is supposed to be per-frame, this
> + * single frame context stores data related to both the current frame
> + * and the previous frames, with fields being updated as the algorithms
> + * are run. This needs to be turned into real per-frame data storage.
> + */
> +
>  } /* namespace libcamera::ipa::rkisp1 */
> --
> Regards,
>
> Laurent Pinchart
>