Message ID | 20211022151218.111966-18-jeanmichel.hautbois@ideasonboard.com |
---|---|
State | Changes Requested |
Headers | show |
Series |
|
Related | show |
Hi Jean-Michel, Thank you for the patch. On Fri, Oct 22, 2021 at 05:12:16PM +0200, Jean-Michel Hautbois wrote: > Doxygen warns us because the structures are referenced as \struct while > they should be \var. Fix it. > > Signed-off-by: Jean-Michel Hautbois <jeanmichel.hautbois@ideasonboard.com> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> > --- > src/ipa/ipu3/ipa_context.cpp | 12 ++++++------ > 1 file changed, 6 insertions(+), 6 deletions(-) > > diff --git a/src/ipa/ipu3/ipa_context.cpp b/src/ipa/ipu3/ipa_context.cpp > index 3c5aa89a..677c90fe 100644 > --- a/src/ipa/ipu3/ipa_context.cpp > +++ b/src/ipa/ipu3/ipa_context.cpp > @@ -56,7 +56,7 @@ namespace libcamera::ipa::ipu3 { > */ > > /** > - * \struct IPASessionConfiguration::grid > + * \var IPASessionConfiguration::grid > * \brief Grid configuration of the IPA > * > * \var IPASessionConfiguration::bdsGrid > @@ -70,7 +70,7 @@ namespace libcamera::ipa::ipu3 { > */ > > /** > - * \struct IPASessionConfiguration::agc > + * \var IPASessionConfiguration::agc > * \brief AGC parameters configuration of the IPA > * > * \var IPASessionConfiguration::minShutterSpeed > @@ -87,7 +87,7 @@ namespace libcamera::ipa::ipu3 { > */ > > /** > - * \struct IPAFrameContext::agc > + * \var IPAFrameContext::agc > * \brief Context for the Automatic Gain Control algorithm > * > * The exposure and gain determined are expected to be applied to the sensor > @@ -103,10 +103,10 @@ namespace libcamera::ipa::ipu3 { > */ > > /** > - * \struct IPAFrameContext::awb > + * \var IPAFrameContext::awb > * \brief Context for the Automatic White Balance algorithm > * > - * \struct IPAFrameContext::gains > + * \var IPAFrameContext::gains > * \brief White balance gains > * > * \var IPAFrameContext::red > @@ -120,7 +120,7 @@ namespace libcamera::ipa::ipu3 { > */ > > /** > - * \struct IPAFrameContext::toneMapping > + * \var IPAFrameContext::toneMapping > * \brief Context for ToneMapping and Gamma control > * > * \var IPAFrameContext::gamma
Quoting Jean-Michel Hautbois (2021-10-22 16:12:16) > Doxygen warns us because the structures are referenced as \struct while > they should be \var. Fix it. > > Signed-off-by: Jean-Michel Hautbois <jeanmichel.hautbois@ideasonboard.com> Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com> > --- > src/ipa/ipu3/ipa_context.cpp | 12 ++++++------ > 1 file changed, 6 insertions(+), 6 deletions(-) > > diff --git a/src/ipa/ipu3/ipa_context.cpp b/src/ipa/ipu3/ipa_context.cpp > index 3c5aa89a..677c90fe 100644 > --- a/src/ipa/ipu3/ipa_context.cpp > +++ b/src/ipa/ipu3/ipa_context.cpp > @@ -56,7 +56,7 @@ namespace libcamera::ipa::ipu3 { > */ > > /** > - * \struct IPASessionConfiguration::grid > + * \var IPASessionConfiguration::grid > * \brief Grid configuration of the IPA > * > * \var IPASessionConfiguration::bdsGrid > @@ -70,7 +70,7 @@ namespace libcamera::ipa::ipu3 { > */ > > /** > - * \struct IPASessionConfiguration::agc > + * \var IPASessionConfiguration::agc > * \brief AGC parameters configuration of the IPA > * > * \var IPASessionConfiguration::minShutterSpeed > @@ -87,7 +87,7 @@ namespace libcamera::ipa::ipu3 { > */ > > /** > - * \struct IPAFrameContext::agc > + * \var IPAFrameContext::agc > * \brief Context for the Automatic Gain Control algorithm > * > * The exposure and gain determined are expected to be applied to the sensor > @@ -103,10 +103,10 @@ namespace libcamera::ipa::ipu3 { > */ > > /** > - * \struct IPAFrameContext::awb > + * \var IPAFrameContext::awb > * \brief Context for the Automatic White Balance algorithm > * > - * \struct IPAFrameContext::gains > + * \var IPAFrameContext::gains > * \brief White balance gains > * > * \var IPAFrameContext::red > @@ -120,7 +120,7 @@ namespace libcamera::ipa::ipu3 { > */ > > /** > - * \struct IPAFrameContext::toneMapping > + * \var IPAFrameContext::toneMapping > * \brief Context for ToneMapping and Gamma control > * > * \var IPAFrameContext::gamma > -- > 2.32.0 >
diff --git a/src/ipa/ipu3/ipa_context.cpp b/src/ipa/ipu3/ipa_context.cpp index 3c5aa89a..677c90fe 100644 --- a/src/ipa/ipu3/ipa_context.cpp +++ b/src/ipa/ipu3/ipa_context.cpp @@ -56,7 +56,7 @@ namespace libcamera::ipa::ipu3 { */ /** - * \struct IPASessionConfiguration::grid + * \var IPASessionConfiguration::grid * \brief Grid configuration of the IPA * * \var IPASessionConfiguration::bdsGrid @@ -70,7 +70,7 @@ namespace libcamera::ipa::ipu3 { */ /** - * \struct IPASessionConfiguration::agc + * \var IPASessionConfiguration::agc * \brief AGC parameters configuration of the IPA * * \var IPASessionConfiguration::minShutterSpeed @@ -87,7 +87,7 @@ namespace libcamera::ipa::ipu3 { */ /** - * \struct IPAFrameContext::agc + * \var IPAFrameContext::agc * \brief Context for the Automatic Gain Control algorithm * * The exposure and gain determined are expected to be applied to the sensor @@ -103,10 +103,10 @@ namespace libcamera::ipa::ipu3 { */ /** - * \struct IPAFrameContext::awb + * \var IPAFrameContext::awb * \brief Context for the Automatic White Balance algorithm * - * \struct IPAFrameContext::gains + * \var IPAFrameContext::gains * \brief White balance gains * * \var IPAFrameContext::red @@ -120,7 +120,7 @@ namespace libcamera::ipa::ipu3 { */ /** - * \struct IPAFrameContext::toneMapping + * \var IPAFrameContext::toneMapping * \brief Context for ToneMapping and Gamma control * * \var IPAFrameContext::gamma
Doxygen warns us because the structures are referenced as \struct while they should be \var. Fix it. Signed-off-by: Jean-Michel Hautbois <jeanmichel.hautbois@ideasonboard.com> --- src/ipa/ipu3/ipa_context.cpp | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-)