| Message ID | 20221019110434.17767-2-laurent.pinchart@ideasonboard.com |
|---|---|
| State | Accepted |
| Headers | show |
| Series |
|
| Related | show |
Quoting Laurent Pinchart via libcamera-devel (2022-10-19 12:04:31) > A few periods crept in at the end of Doxygen \brief or \param statements > in the src/ipa/ directory. Remove them all in one go. > All of the patches are this easy right ... Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com> > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> > --- > src/ipa/ipu3/algorithms/af.cpp | 18 +++++++++--------- > src/ipa/ipu3/ipa_context.cpp | 6 +++--- > src/ipa/libipa/algorithm.cpp | 2 +- > src/ipa/libipa/histogram.cpp | 2 +- > 4 files changed, 14 insertions(+), 14 deletions(-) > > diff --git a/src/ipa/ipu3/algorithms/af.cpp b/src/ipa/ipu3/algorithms/af.cpp > index b00a34f9e090..75632aa39d21 100644 > --- a/src/ipa/ipu3/algorithms/af.cpp > +++ b/src/ipa/ipu3/algorithms/af.cpp > @@ -267,9 +267,9 @@ void Af::afReset(IPAContext &context) > } > > /** > - * \brief AF variance comparison. > + * \brief AF variance comparison > * \param[in] context The IPA context > - * \param[in] min_step The VCM movement step. > + * \param[in] min_step The VCM movement step > * > * We always pick the largest variance to replace the previous one. The image > * with a larger variance also indicates it is a clearer image than previous > @@ -322,7 +322,7 @@ bool Af::afScan(IPAContext &context, int min_step) > } > > /** > - * \brief Determine the frame to be ignored. > + * \brief Determine the frame to be ignored > * \return Return True if the frame should be ignored, false otherwise > */ > bool Af::afNeedIgnoreFrame() > @@ -335,7 +335,7 @@ bool Af::afNeedIgnoreFrame() > } > > /** > - * \brief Reset frame ignore counter. > + * \brief Reset frame ignore counter > */ > void Af::afIgnoreFrameReset() > { > @@ -377,8 +377,8 @@ double Af::afEstimateVariance(Span<const y_table_item_t> y_items, bool isY1) > } > > /** > - * \brief Determine out-of-focus situation. > - * \param[in] context The IPA context. > + * \brief Determine out-of-focus situation > + * \param[in] context The IPA context > * > * Out-of-focus means that the variance change rate for a focused and a new > * variance is greater than a threshold. > @@ -404,11 +404,11 @@ bool Af::afIsOutOfFocus(IPAContext &context) > } > > /** > - * \brief Determine the max contrast image and lens position. > - * \param[in] context The IPA context. > + * \brief Determine the max contrast image and lens position > + * \param[in] context The IPA context > * \param[in] frame The frame context sequence number > * \param[in] frameContext The current frame context > - * \param[in] stats The statistics buffer of IPU3. > + * \param[in] stats The statistics buffer of IPU3 > * > * Ideally, a clear image also has a relatively higher contrast. So, every > * image for each focus step should be tested to find an optimal focus step. > diff --git a/src/ipa/ipu3/ipa_context.cpp b/src/ipa/ipu3/ipa_context.cpp > index f276227c1ecc..68f017b04751 100644 > --- a/src/ipa/ipu3/ipa_context.cpp > +++ b/src/ipa/ipu3/ipa_context.cpp > @@ -68,7 +68,7 @@ namespace libcamera::ipa::ipu3 { > * \brief AF grid configuration of the IPA > * > * \var IPASessionConfiguration::af.afGrid > - * \brief AF scene grid configuration. > + * \brief AF scene grid configuration > */ > > /** > @@ -79,10 +79,10 @@ namespace libcamera::ipa::ipu3 { > * \brief Current position of the lens > * > * \var IPAActiveState::af.maxVariance > - * \brief The maximum variance of the current image. > + * \brief The maximum variance of the current image > * > * \var IPAActiveState::af.stable > - * \brief It is set to true, if the best focus is found. > + * \brief It is set to true, if the best focus is found > */ > > /** > diff --git a/src/ipa/libipa/algorithm.cpp b/src/ipa/libipa/algorithm.cpp > index c152b885aee1..55abddab2b0a 100644 > --- a/src/ipa/libipa/algorithm.cpp > +++ b/src/ipa/libipa/algorithm.cpp > @@ -72,7 +72,7 @@ namespace ipa { > * \param[in] context The shared IPA context > * \param[in] frame The frame context sequence number > * \param[in] frameContext The FrameContext for this frame > - * \param[out] params The ISP specific parameters. > + * \param[out] params The ISP specific parameters > * > * This function is called for every frame when the camera is running before it > * is processed by the ISP to prepare the ISP processing parameters for that > diff --git a/src/ipa/libipa/histogram.cpp b/src/ipa/libipa/histogram.cpp > index 69b461779a1f..6b5cde8e0ab3 100644 > --- a/src/ipa/libipa/histogram.cpp > +++ b/src/ipa/libipa/histogram.cpp > @@ -53,7 +53,7 @@ Histogram::Histogram(Span<const uint32_t> data) > */ > > /** > - * \brief Cumulative frequency up to a (fractional) point in a bin. > + * \brief Cumulative frequency up to a (fractional) point in a bin > * \param[in] bin The bin up to which to cumulate > * > * With F(p) the cumulative frequency of the histogram, the value is 0 at > -- > Regards, > > Laurent Pinchart >
Hi Laurent On Wed, Oct 19, 2022 at 02:04:31PM +0300, Laurent Pinchart via libcamera-devel wrote: > A few periods crept in at the end of Doxygen \brief or \param statements > in the src/ipa/ directory. Remove them all in one go. > > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> That's an easy one Reviewed-by: Jacopo Mondi <jacopo@jmondi.org> Thanks j > --- > src/ipa/ipu3/algorithms/af.cpp | 18 +++++++++--------- > src/ipa/ipu3/ipa_context.cpp | 6 +++--- > src/ipa/libipa/algorithm.cpp | 2 +- > src/ipa/libipa/histogram.cpp | 2 +- > 4 files changed, 14 insertions(+), 14 deletions(-) > > diff --git a/src/ipa/ipu3/algorithms/af.cpp b/src/ipa/ipu3/algorithms/af.cpp > index b00a34f9e090..75632aa39d21 100644 > --- a/src/ipa/ipu3/algorithms/af.cpp > +++ b/src/ipa/ipu3/algorithms/af.cpp > @@ -267,9 +267,9 @@ void Af::afReset(IPAContext &context) > } > > /** > - * \brief AF variance comparison. > + * \brief AF variance comparison > * \param[in] context The IPA context > - * \param[in] min_step The VCM movement step. > + * \param[in] min_step The VCM movement step > * > * We always pick the largest variance to replace the previous one. The image > * with a larger variance also indicates it is a clearer image than previous > @@ -322,7 +322,7 @@ bool Af::afScan(IPAContext &context, int min_step) > } > > /** > - * \brief Determine the frame to be ignored. > + * \brief Determine the frame to be ignored > * \return Return True if the frame should be ignored, false otherwise > */ > bool Af::afNeedIgnoreFrame() > @@ -335,7 +335,7 @@ bool Af::afNeedIgnoreFrame() > } > > /** > - * \brief Reset frame ignore counter. > + * \brief Reset frame ignore counter > */ > void Af::afIgnoreFrameReset() > { > @@ -377,8 +377,8 @@ double Af::afEstimateVariance(Span<const y_table_item_t> y_items, bool isY1) > } > > /** > - * \brief Determine out-of-focus situation. > - * \param[in] context The IPA context. > + * \brief Determine out-of-focus situation > + * \param[in] context The IPA context > * > * Out-of-focus means that the variance change rate for a focused and a new > * variance is greater than a threshold. > @@ -404,11 +404,11 @@ bool Af::afIsOutOfFocus(IPAContext &context) > } > > /** > - * \brief Determine the max contrast image and lens position. > - * \param[in] context The IPA context. > + * \brief Determine the max contrast image and lens position > + * \param[in] context The IPA context > * \param[in] frame The frame context sequence number > * \param[in] frameContext The current frame context > - * \param[in] stats The statistics buffer of IPU3. > + * \param[in] stats The statistics buffer of IPU3 > * > * Ideally, a clear image also has a relatively higher contrast. So, every > * image for each focus step should be tested to find an optimal focus step. > diff --git a/src/ipa/ipu3/ipa_context.cpp b/src/ipa/ipu3/ipa_context.cpp > index f276227c1ecc..68f017b04751 100644 > --- a/src/ipa/ipu3/ipa_context.cpp > +++ b/src/ipa/ipu3/ipa_context.cpp > @@ -68,7 +68,7 @@ namespace libcamera::ipa::ipu3 { > * \brief AF grid configuration of the IPA > * > * \var IPASessionConfiguration::af.afGrid > - * \brief AF scene grid configuration. > + * \brief AF scene grid configuration > */ > > /** > @@ -79,10 +79,10 @@ namespace libcamera::ipa::ipu3 { > * \brief Current position of the lens > * > * \var IPAActiveState::af.maxVariance > - * \brief The maximum variance of the current image. > + * \brief The maximum variance of the current image > * > * \var IPAActiveState::af.stable > - * \brief It is set to true, if the best focus is found. > + * \brief It is set to true, if the best focus is found > */ > > /** > diff --git a/src/ipa/libipa/algorithm.cpp b/src/ipa/libipa/algorithm.cpp > index c152b885aee1..55abddab2b0a 100644 > --- a/src/ipa/libipa/algorithm.cpp > +++ b/src/ipa/libipa/algorithm.cpp > @@ -72,7 +72,7 @@ namespace ipa { > * \param[in] context The shared IPA context > * \param[in] frame The frame context sequence number > * \param[in] frameContext The FrameContext for this frame > - * \param[out] params The ISP specific parameters. > + * \param[out] params The ISP specific parameters > * > * This function is called for every frame when the camera is running before it > * is processed by the ISP to prepare the ISP processing parameters for that > diff --git a/src/ipa/libipa/histogram.cpp b/src/ipa/libipa/histogram.cpp > index 69b461779a1f..6b5cde8e0ab3 100644 > --- a/src/ipa/libipa/histogram.cpp > +++ b/src/ipa/libipa/histogram.cpp > @@ -53,7 +53,7 @@ Histogram::Histogram(Span<const uint32_t> data) > */ > > /** > - * \brief Cumulative frequency up to a (fractional) point in a bin. > + * \brief Cumulative frequency up to a (fractional) point in a bin > * \param[in] bin The bin up to which to cumulate > * > * With F(p) the cumulative frequency of the histogram, the value is 0 at > -- > Regards, > > Laurent Pinchart >
diff --git a/src/ipa/ipu3/algorithms/af.cpp b/src/ipa/ipu3/algorithms/af.cpp index b00a34f9e090..75632aa39d21 100644 --- a/src/ipa/ipu3/algorithms/af.cpp +++ b/src/ipa/ipu3/algorithms/af.cpp @@ -267,9 +267,9 @@ void Af::afReset(IPAContext &context) } /** - * \brief AF variance comparison. + * \brief AF variance comparison * \param[in] context The IPA context - * \param[in] min_step The VCM movement step. + * \param[in] min_step The VCM movement step * * We always pick the largest variance to replace the previous one. The image * with a larger variance also indicates it is a clearer image than previous @@ -322,7 +322,7 @@ bool Af::afScan(IPAContext &context, int min_step) } /** - * \brief Determine the frame to be ignored. + * \brief Determine the frame to be ignored * \return Return True if the frame should be ignored, false otherwise */ bool Af::afNeedIgnoreFrame() @@ -335,7 +335,7 @@ bool Af::afNeedIgnoreFrame() } /** - * \brief Reset frame ignore counter. + * \brief Reset frame ignore counter */ void Af::afIgnoreFrameReset() { @@ -377,8 +377,8 @@ double Af::afEstimateVariance(Span<const y_table_item_t> y_items, bool isY1) } /** - * \brief Determine out-of-focus situation. - * \param[in] context The IPA context. + * \brief Determine out-of-focus situation + * \param[in] context The IPA context * * Out-of-focus means that the variance change rate for a focused and a new * variance is greater than a threshold. @@ -404,11 +404,11 @@ bool Af::afIsOutOfFocus(IPAContext &context) } /** - * \brief Determine the max contrast image and lens position. - * \param[in] context The IPA context. + * \brief Determine the max contrast image and lens position + * \param[in] context The IPA context * \param[in] frame The frame context sequence number * \param[in] frameContext The current frame context - * \param[in] stats The statistics buffer of IPU3. + * \param[in] stats The statistics buffer of IPU3 * * Ideally, a clear image also has a relatively higher contrast. So, every * image for each focus step should be tested to find an optimal focus step. diff --git a/src/ipa/ipu3/ipa_context.cpp b/src/ipa/ipu3/ipa_context.cpp index f276227c1ecc..68f017b04751 100644 --- a/src/ipa/ipu3/ipa_context.cpp +++ b/src/ipa/ipu3/ipa_context.cpp @@ -68,7 +68,7 @@ namespace libcamera::ipa::ipu3 { * \brief AF grid configuration of the IPA * * \var IPASessionConfiguration::af.afGrid - * \brief AF scene grid configuration. + * \brief AF scene grid configuration */ /** @@ -79,10 +79,10 @@ namespace libcamera::ipa::ipu3 { * \brief Current position of the lens * * \var IPAActiveState::af.maxVariance - * \brief The maximum variance of the current image. + * \brief The maximum variance of the current image * * \var IPAActiveState::af.stable - * \brief It is set to true, if the best focus is found. + * \brief It is set to true, if the best focus is found */ /** diff --git a/src/ipa/libipa/algorithm.cpp b/src/ipa/libipa/algorithm.cpp index c152b885aee1..55abddab2b0a 100644 --- a/src/ipa/libipa/algorithm.cpp +++ b/src/ipa/libipa/algorithm.cpp @@ -72,7 +72,7 @@ namespace ipa { * \param[in] context The shared IPA context * \param[in] frame The frame context sequence number * \param[in] frameContext The FrameContext for this frame - * \param[out] params The ISP specific parameters. + * \param[out] params The ISP specific parameters * * This function is called for every frame when the camera is running before it * is processed by the ISP to prepare the ISP processing parameters for that diff --git a/src/ipa/libipa/histogram.cpp b/src/ipa/libipa/histogram.cpp index 69b461779a1f..6b5cde8e0ab3 100644 --- a/src/ipa/libipa/histogram.cpp +++ b/src/ipa/libipa/histogram.cpp @@ -53,7 +53,7 @@ Histogram::Histogram(Span<const uint32_t> data) */ /** - * \brief Cumulative frequency up to a (fractional) point in a bin. + * \brief Cumulative frequency up to a (fractional) point in a bin * \param[in] bin The bin up to which to cumulate * * With F(p) the cumulative frequency of the histogram, the value is 0 at
A few periods crept in at the end of Doxygen \brief or \param statements in the src/ipa/ directory. Remove them all in one go. Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> --- src/ipa/ipu3/algorithms/af.cpp | 18 +++++++++--------- src/ipa/ipu3/ipa_context.cpp | 6 +++--- src/ipa/libipa/algorithm.cpp | 2 +- src/ipa/libipa/histogram.cpp | 2 +- 4 files changed, 14 insertions(+), 14 deletions(-)