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

Possibility to disable special CGAL documentation setting #7589

Merged
merged 1 commit into from
Jul 17, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions Documentation/doc/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,18 @@ else()
"#EXTRACT_ALL_NO_DETAILED_IF_EMPTY = NO")
endif()

option(CGAL_NO_ADDITIONAL_DETAILS
"Use CGAL special doxygen setting NO_ADDITIONAL_DETAILS." ON)
if(CGAL_NO_ADDITIONAL_DETAILS)
set(CGAL_OPT_NO_ADDITIONAL_DETAILS
"NO_ADDITIONAL_DETAILS = YES")
else()
# The default is NO, so we could leave it out, but it is better to have a commented out placeholder
# this will work for versions with and without the setting.
set(CGAL_OPT_NO_ADDITIONAL_DETAILS
"#NO_ADDITIONAL_DETAILS = NO")
endif()

#we use two directories for the generation/reading of tag files to prevent issues
#if the targets are built in parallel
set(CGAL_DOC_TAG_GEN_DIR "${CMAKE_BINARY_DIR}/doc_gen_tags")
Expand Down
2 changes: 1 addition & 1 deletion Documentation/doc/resources/1.8.13/BaseDoxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ EXTRACT_ALL = YES
# the EXTRACT_ALL tag is set to NO.
# The default value is: NO.

EXTRACT_ALL_NO_DETAILED_IF_EMPTY = YES
${CGAL_OPT_EXTRACT_ALL_NO_DETAILED_IF_EMPTY}

# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
# included in the documentation.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/doc/resources/1.9.6/BaseDoxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -791,5 +791,5 @@ GENERATE_LEGEND = NO
# NO_ADDITIONAL_DETAILS tag is set to YES. This tag has no effect if
# the EXTRACT_ALL tag is set to NO.
# The default value is: NO.
NO_ADDITIONAL_DETAILS = YES
${CGAL_OPT_NO_ADDITIONAL_DETAILS}