Navtree broken with doxygen master

[sloriot]

We see here: https://cgal.geometryfactory.com/CGAL/Manual_doxygen_test/CGAL-5.3-Ic-101/master/Manual/index.html

That the navtree is broken and collects too many items.

We should start by bisecting doxygen to see when the regression was introduced. @maxGimeno could you handle that?

cc @albert-github

[sloriot]

There is also the CGAL on the top of the page that is now a href.

[albert-github]

Which href do you mean, I don't see it or I don't understand what you mean. Maybe an image might shine a light on it (same accounts for the original issue, although this is quite obvious to see at the moment, but an image with the good and wrong status might not hurt).

[maxGimeno]

The underlined CGAL in CGAL 5.3 Manual should not be a link. The original issue is that the research tool doesn't work.

[sloriot]

No original issue is the navtree: Broken on the left, OK on the right.

[maxGimeno]

Ok, but the research tool doesn't work and it is also an issue EDIT: My bad, it was only a caps issue, nothing wrong here

[sloriot]

There is also issue in https://cgal.geometryfactory.com/CGAL/Manual_doxygen_test/CGAL-5.3-Ic-101/master/Manual/packages.html with the license macros

[maxGimeno]

Bisection says that 33b0f4d25dff25b0e50d62eff68155106e88d58d is the culprit

[albert-github]

@maxGimeno does this also cause all the errors or just part of the errors?

• navtree: https://github.com/CGAL/cgal/issues/5600#issue-854265185
• href: https://github.com/CGAL/cgal/issues/5600#issuecomment-816488021
• license: https://github.com/CGAL/cgal/issues/5600#issuecomment-816521169

[maxGimeno]

Only the main error about the navtree. I'll keep digging for the other ones.

[maxGimeno]

The href comes from here

[maxGimeno]

and the thing about the macro comes from here

[albert-github]

Thanks for the bisecting work.

[albert-github]

Regarding the incorrect link (), I see here multiple different, inconsistent, uses of the word CGAL(https://github.com/CGAL/cgal/issues/5600#issuecomment-816488021, https://github.com/CGAL/cgal/issues/5600#issuecomment-816517682and https://github.com/CGAL/cgal/issues/5600#issuecomment-816675485):

(on purpose I made the links red to be able to see them better).

1. as a normal word CGAL, written in the text as %CGAL.
2. as a link, pointing to the CGAL namespace. This is is done by means of the comamnd \cgal and thus by the ALIASES = "cgal=CGAL", When we change this ALIAS to ALIASES = "cgal=%CGAL" these lins will be gone. There might be also some uses of the word CGAL that should not refer to the namespace (I didn't see it at first glance, but need some thorough inspection).
3. in header, for this use of the word CGAL I have not yet a solution, when I would replace it with %CGAL then we would also see the % on the top left and in the description in the tab.

I think the points 1. and 2. are not caused by the change https://github.com/doxygen/doxygen/commit/37deea7dc7f4d3e6d1df167471a01d3933a65602 Point 3. I have to investigate further

(regarding the other 2 issues: navtree, href I will forward these, didn't see a solution yet).

[sloriot]

Note that 1 and 2 are fixed by #5596 as can be seen here

[albert-github]

Regarding the point 2. of my previous comment https://github.com/CGAL/cgal/issues/5600#issuecomment-816811189 this indeed loos to be fixed by #5596. The point 1. was the remark that in the text there are some words meaning both the CGAL product are written differently: once as %CGAL and once as \cgal (where we now can assume that \cgal will have the right content). I think the %CGAL in the text should be replaced by \cgal to have it really uniform (and when e.g. somrbody decides that the word should e.g. be in italics this is very easy to do at that moment).

[albert-github]

Regarding the point 3. of the "href link" (https://github.com/CGAL/cgal/issues/5600#issuecomment-816811189) I have found a workaround (one that lies in my box of tricks): in the file: Documentation/doc/Documentation/Doxyfile.in replace the line:

PROJECT_NAME = "CGAL ${CGAL_DOC_VERSION} - Manual"

with

PROJECT_NAME = "C‍GAL ${CGAL_DOC_VERSION} - Manual"

the ‍ is the so called "Zero width Joiner" a non printable character.

(I would like a better solution by means of %CGAL but I don't think this will be easily possible, when I find something I'll report it here as well. Best now is to use the workaround).

[albert-github]

The problems 1. and 3. (Treeview and "License") problems have been solved in the doxygen master branch (but cannot yet be tested on the CGAL systems due to some other, big, doxygen problem giving strange output file names).

Problem 2. (the CGAL <-> %CGAL) a workaround is given.

[albert-github]

The problem problem 1. and 3. can be tested again as the problem regarding the output file names has been solved. For problem 2. the workaround has to be used.

[sloriot]

I confirm all is fixed together with #5643