Fix #9369: Inline Doxygen documentation for tags.hMerge tags.h documentation into source file#9382
Open
sainathmanda7 wants to merge 3 commits intoCGAL:mainfrom
Open
Fix #9369: Inline Doxygen documentation for tags.hMerge tags.h documentation into source file#9382sainathmanda7 wants to merge 3 commits intoCGAL:mainfrom
sainathmanda7 wants to merge 3 commits intoCGAL:mainfrom
Conversation
Moves the Doxygen comments from the detached doc file directly into the header file. Fixes CGAL#9369
afabri
reviewed
Mar 18, 2026
| struct Parallel_tag : public Sequential_tag { static constexpr bool is_parallel = true; }; | ||
|
|
||
| #ifdef CGAL_LINKED_WITH_TBB | ||
| /// \ingroup PkgSTLExtensionUtilities |
Member
There was a problem hiding this comment.
It makes no sense to have documentation to depend on a macro
Member
|
/build:v0 |
|
There was an error while building the doc: |
Member
|
It would be good practice to run doxygen locally (not directly but activating documentation generation in cmake .. and make doc) |
Member
|
Have a look at the Doxyfile.in of the Polygon Mesh Processing package to see how to handle some doxygen in directory |
Author
|
@afabri Thanks for pointing me to that example! I’ve updated Doxyfile.in for the STL_Extension package to include tags.h in the INPUT list, which should fix the documentation generation. Let me know if this looks good or if any further changes are needed. |
Member
|
Hello @sainathmanda7, |
Author
|
Am sorry and Thankyou for your advice sir, Thankyou sir. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR resolves issue #9369 by moving the Doxygen documentation for
<CGAL/tags.h>directly into the source code to act as the single source of truth.Changes made:
///) from the detached documentation file directly intoSTL_Extension/include/CGAL/tags.h, placing them immediately above their respectivestructandtypedefdeclarations.STL_Extension/doc/STL_Extension/CGAL/tags.hfile to prevent duplicate documentation warnings and clean up the file tree.Fixes #9369