[libcamera-devel] [PATCH] Documentation: Drop deprecated Doxygen COLS_IN_ALPHA_INDEX option

[Laurent Pinchart]

Hi Umang,

On Thu, Dec 24, 2020 at 09:45:00PM +0530, Umang Jain wrote:
> Hi Laurent,
> 
> I happen to do a quick test with master branch of Doxygen. I noticed 
> that we do not enforce any minimum version requirement for Doxygen in 
> our source tree, which implies that one can be running any version of 
> Doxygen(including master), in that view,

Correct. I think the minimal version we need is one that hasn't been
released yet :-) There are open issues in doxygen that affect us. We
have workarounds for some of them. I personally target a warning-free
build with the doxygen master branch. Once all the problems affecting us
will be fixed, in a released version, we should probably set that as our
recommended target.

> On 12/24/20 2:26 PM, Laurent Pinchart wrote:
> > The Doxygen COLS_IN_ALPHA_INDEX option is deprecated, and generates a
> > warning with the Doxygen's master branch. Drop it.
> >
> > Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>
>
> Tested-by: Umang Jain <email at uajain.com>
> Reviewed-by: Umang Jain <email at uajain.com>
>
> > ---
> >   Documentation/Doxyfile.in | 7 -------
> >   1 file changed, 7 deletions(-)
> >
> > diff --git a/Documentation/Doxyfile.in b/Documentation/Doxyfile.in
> > index 4bbacc464a5e..c986fb6ab899 100644
> > --- a/Documentation/Doxyfile.in
> > +++ b/Documentation/Doxyfile.in
> > @@ -1059,13 +1059,6 @@ VERBATIM_HEADERS       = YES
> >   
> >   ALPHABETICAL_INDEX     = YES
> >   
> > -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
> > -# which the alphabetical index list will be split.
> > -# Minimum value: 1, maximum value: 20, default value: 5.
> > -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
> > -
> > -COLS_IN_ALPHA_INDEX    = 5
> > -
> >   # In case all classes in a project start with a common prefix, all classes will
> >   # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
> >   # can be used to specify a prefix (or a list of prefixes) that should be ignored

-- 
Regards,

Laurent Pinchart