cgal icon indicating copy to clipboard operation
cgal copied to clipboard

Published 20 hours ago • verified publisher icon CGAL

Removing page outline panel

Open albert-github opened this issue 6 months ago • 9 comments
trafficstars

In the current master version of doxygen (and thus upcoming version 1.14.0) a page outline panel is introduced, setting: PAGE_OUTLINE_PANEL, though it would be better to disable this in CGAL.

With the setting PAGE_OUTLINE_PANEL=YES (the default):

image

With the setting PAGE_OUTLINE_PANEL=NO:

image

albert-github avatar Apr 27 '25 08:04 albert-github

I guess it cannot replace our navigation panel ?

afabri avatar Apr 30 '25 08:04 afabri

@afabri Which "our navigation panel " do you mean ?

albert-github avatar Apr 30 '25 08:04 albert-github

@afabri Which "our navigation panel " do you mean ?

The panel on the left.

afabri avatar May 05 '25 06:05 afabri

@afabri At the moment this is not possible as PAGE_OUTLINE_PANEL (the right panel) requires that GENERATE_TREEVIEW (generating the left panel) is set.

albert-github avatar May 05 '25 07:05 albert-github

@sloriot do you think we have to test this or can you simply merge ?

afabri avatar May 22 '25 14:05 afabri

was PAGE_OUTLINE_PANEL introduced in 1.10?

sloriot avatar May 22 '25 15:05 sloriot

No this has not been introduced in 1.10.0 but will be available in 1.14.0 release (and thus in the current master). The directory is called 1.10.0 as it was originally based on 1.10.0 master.

albert-github avatar May 22 '25 16:05 albert-github

So I need to create a new directory otherwise we'll get warnings with version between 1.10 and 1.14.

sloriot avatar May 22 '25 16:05 sloriot

I don't think so. The directory that is now called 1.10.0 is only used for the tests with the master version of doxygen. The other directory and version currently used for generation the documentation is 1.9.6. When I remember correctly the 1.8.13 directory and version is only used to compares some XML output from doxygen.

I think it would be better to wait for the release of the doxygen 1.14.0 version (which is expected in the next 2 weeks) and use this version for future new versions (6.2 and up) of CGAL. At that moment it would be best to rename the 1.10.0 directory to 1.14.0 and create a new directory which should in my opinion be called master. Also the 1.8.13 directory should be dropped and when necessary replaced by, preferably, 1.14.0 as well for all versions (as it is only used internally by CGAL.

(I think there might be already an issue regarding discarding 1.8.13 completely and using a newer version.)

albert-github avatar May 23 '25 07:05 albert-github

Successfully tested in CGAL-6.1-Ic-209

sloriot avatar Aug 04 '25 06:08 sloriot