Skip to content

Removing page outline panel #8865

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

albert-github
Copy link
Contributor

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

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.
@afabri
Copy link
Member

afabri commented Apr 30, 2025

I guess it cannot replace our navigation panel ?

@albert-github
Copy link
Contributor Author

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

@afabri
Copy link
Member

afabri commented May 5, 2025

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

The panel on the left.

@albert-github
Copy link
Contributor Author

@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.

@afabri
Copy link
Member

afabri commented May 22, 2025

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

@sloriot
Copy link
Member

sloriot commented May 22, 2025

was PAGE_OUTLINE_PANEL introduced in 1.10?

@albert-github
Copy link
Contributor Author

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.

@sloriot
Copy link
Member

sloriot commented May 22, 2025

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

@sloriot sloriot added the TODO label May 22, 2025
@albert-github
Copy link
Contributor Author

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.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants