Skip to content
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

Defining a new resource directory to be used with doxygen master 1.10.0 #7758

Merged

Conversation

albert-github
Copy link
Contributor

@albert-github albert-github commented Oct 5, 2023

Doxygen master 1.10.0 has support for the c++ concept of modules but as in the past doxygen used the term "modules" for the grouping of information (commands like \defgroup, \ingroup etc.) a new term for the later has been introduced: Topics. The introduction of the new term also has some influence on the generated files and file names. The consequence of this is that part of CGAL documentation (i.e. the "Reference Manual" item) didn't appear anymore in a.o. the treeview.

  • creating a new setup
  • adding the "topics" to the layout files as in the past the "modules" were.
  • adjusting the "hack.js" where some manipulation of the TreeView is done and this had "modules" coded into it.
  • adjusting the "header_packages.html" as this used the name "modules.js"

Doxygen master 1.10.0 has support for the c++ concept of modules but as in the past doxygen used the term "modules" for the grouping of information (`commands like `\defgroup`, `\ingroup` etc.) an new term for the later has been introduced: Topics.
The introduction of the new term also has some influence on the generated files and file names.
The consequence of this is that part of CGAL documentation (i.e. the "Reference Manual") item didn't appear anymore in a.o. the treeview.
- creating a new setup
- adding the "topics" to the layout files as in the past the "modules" were.
- adjusting the "hack.js" where some manipulation of the TreeView is done and this had "modules" coded into it.
- adjusting the "header_packages.html" as this used the name "modules.js"
Adding the, new, possibility for `HTML_COPY_CLIPBOARD`:
> If the `HTML_COPY_CLIPBOARD` tag is set to `YES` then doxygen will show an icon
> the top right of code and text fragments that allows the user to copy the contents to the clipboard (provided
> this is supported by the browser).
@albert-github
Copy link
Contributor Author

Ready to be tested.

@lrineau lrineau added the Doc label Oct 30, 2023
@lrineau lrineau added this to the 6.0-beta milestone Oct 30, 2023
@sloriot sloriot added Batch_1 First Batch of PRs under testing Under Testing and removed Batch_1 First Batch of PRs under testing labels Oct 31, 2023
Adding the possibilities for the new setting `` so the CGAL setting don't interfere with the settings of other packages.
@sloriot sloriot added the Not yet approved The feature or pull-request has not yet been approved. label Nov 15, 2023
@sloriot
Copy link
Member

sloriot commented Nov 15, 2023

Successfully tested in CGAL-6.0-Ic-106

@github-actions github-actions bot removed the Tested label Nov 15, 2023
Copy link

This pull-request was previously marked with the label Tested, but has been modified with new commits. That label has been removed.

# be stored separately.
# This tag requires that the tag GENERATE_HTML is set to YES.

HTML_PROJECT_COOKIE = CGAL
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have the option to not have any cookie?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No there is no such option. I know there is some resentment against cookies but these cookies were already present and now are a bit more dedicated. These cookies are only stored locally and each user has to set them individually.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know there used to be there, that just reminded me that we talked at some point to try to get rid of it (for compliance with European regulation).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing them would mean that when opening an new page (e.g. shift click a link) the behavior would become undefined and e.g. jump back to default settings.

@sloriot sloriot added Tested and removed Not yet approved The feature or pull-request has not yet been approved. labels Nov 15, 2023
@lrineau lrineau added the rm only: ready for master For the release team only: that indicates that a PR is about to be merged in 'master' label Nov 15, 2023
@lrineau lrineau self-assigned this Nov 15, 2023
@lrineau lrineau merged commit 5a587ee into CGAL:master Nov 15, 2023
9 checks passed
@albert-github albert-github deleted the feature/bug_setup_doxygen_master_1_10_0 branch November 15, 2023 15:45
@lrineau lrineau removed the rm only: ready for master For the release team only: that indicates that a PR is about to be merged in 'master' label Nov 15, 2023
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