Skip to content

STYLE: Remove doxygen.config.in (superseded by DoxygenConfig.cmake)#4500

Merged
thewtex merged 1 commit into
InsightSoftwareConsortium:masterfrom
N-Dekker:Remove-doxygen-config-in
Mar 12, 2024
Merged

STYLE: Remove doxygen.config.in (superseded by DoxygenConfig.cmake)#4500
thewtex merged 1 commit into
InsightSoftwareConsortium:masterfrom
N-Dekker:Remove-doxygen-config-in

Conversation

@N-Dekker
Copy link
Copy Markdown
Contributor

@N-Dekker N-Dekker commented Mar 8, 2024

The use of doxygen.config has been replaced by DoxygenConfig.cmake, with pull request #3311 commit a96d03f
"COMP: Use modern doxygen_add_docs for BUILD_DOCUMENTAITON", Hans Johnson (@hjmjohnson), March 18, 2022

The use of doxygen.config has been replaced by DoxygenConfig.cmake, with
pull request InsightSoftwareConsortium#3311
commit a96d03f
"COMP: Use modern doxygen_add_docs for BUILD_DOCUMENTAITON",
Hans Johnson, March 18, 2022
@N-Dekker N-Dekker requested a review from hjmjohnson March 8, 2024 10:45
@github-actions github-actions Bot added type:Infrastructure Infrastructure/ecosystem related changes, such as CMake or buildbots type:Style Style changes: no logic impact (indentation, comments, naming) area:Documentation Issues affecting the Documentation module labels Mar 8, 2024
Copy link
Copy Markdown
Member

@dzenanz dzenanz left a comment

Choose a reason for hiding this comment

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

Change looks good. Question: Does it affect the doc build process? 😄

@thewtex
Copy link
Copy Markdown
Member

thewtex commented Mar 11, 2024

@N-Dekker did you confirm that the doxygen build succeeds?

@N-Dekker
Copy link
Copy Markdown
Contributor Author

did you confirm that the doxygen build succeeds?

@thewtex I did not try it out locally, but I searched exhaustively for "doxygen.config" in the source tree, and only found it in comments, like:

 # The DoxygenConfig.cmake is a replacement for configuring a doxygen.config.in file

# The DoxygenConfig.cmake is a replacement for configuring a doxygen.config.in file

Before commit a96d03f (March, 2022), Utilities/Doxygen/CMakeLists.txt still configured doxygen.config.in, by doing:

configure_file(${ITK_SOURCE_DIR}/Utilities/Doxygen/doxygen.config.in
               ${ITK_BINARY_DIR}/Utilities/Doxygen/doxygen.config)

That statement was removed by commit a96d03f (March, 2022).

@hjmjohnson Can you confirm that "doxygen.config.in" is no longer necessary, now that we have DoxygenConfig.cmake?

@N-Dekker
Copy link
Copy Markdown
Contributor Author

This pull request may also be considered as a proof that "doxygen.config.in" is no longer used:

Apparently it was sufficient to add itkVirtualGetNameOfClassMacro and itkOverrideGetNameOfClassMacro to "DoxygenConfig.cmake", in order to get GetNameOfClass() documented at https://itk.org/Doxygen/html/ It is no longer necessary to add such macro's to "doxygen.config.in", because "doxygen.config.in" is ignored anyway, nowadays.

@thewtex
Copy link
Copy Markdown
Member

thewtex commented Mar 12, 2024

@N-Dekker it needs to be tested before merging. I will start a local build.

Copy link
Copy Markdown
Member

@thewtex thewtex left a comment

Choose a reason for hiding this comment

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

Build succeeds locally 🟢

@thewtex thewtex merged commit a18183e into InsightSoftwareConsortium:master Mar 12, 2024
N-Dekker added a commit to N-Dekker/ITK that referenced this pull request Mar 12, 2024
nifti2_io.c was removed by:
- pull request InsightSoftwareConsortium#2630
commit 68221fd
"ENH: Prepare for update to NIFTILIB3.0.1", 9 July 2021

The two doxygen.config.in files were removed by:
- pull request InsightSoftwareConsortium#3311
commit a96d03f
"COMP: Use modern doxygen_add_docs command ITK_WRAP_DOCS", 11 March 2022
- pull request InsightSoftwareConsortium#4500
commit 0c5c638
"STYLE: Remove doxygen.config.in (superseded by DoxygenConfig.cmake)", 12 March
2024
@N-Dekker N-Dekker deleted the Remove-doxygen-config-in branch March 13, 2024 01:46
hjmjohnson pushed a commit that referenced this pull request Mar 23, 2024
nifti2_io.c was removed by:
- pull request #2630
commit 68221fd
"ENH: Prepare for update to NIFTILIB3.0.1", 9 July 2021

The two doxygen.config.in files were removed by:
- pull request #3311
commit a96d03f
"COMP: Use modern doxygen_add_docs command ITK_WRAP_DOCS", 11 March 2022
- pull request #4500
commit 0c5c638
"STYLE: Remove doxygen.config.in (superseded by DoxygenConfig.cmake)", 12 March
2024
hjmjohnson pushed a commit to hjmjohnson/ITK that referenced this pull request May 6, 2026
…e-doxygen-config-in

STYLE: Remove doxygen.config.in (superseded by DoxygenConfig.cmake)
hjmjohnson pushed a commit to hjmjohnson/ITK that referenced this pull request May 6, 2026
nifti2_io.c was removed by:
- pull request InsightSoftwareConsortium#2630
commit 5e64b4b
"ENH: Prepare for update to NIFTILIB3.0.1", 9 July 2021

The two doxygen.config.in files were removed by:
- pull request InsightSoftwareConsortium#3311
commit edae38c
"COMP: Use modern doxygen_add_docs command ITK_WRAP_DOCS", 11 March 2022
- pull request InsightSoftwareConsortium#4500
commit 8098f8b
"STYLE: Remove doxygen.config.in (superseded by DoxygenConfig.cmake)", 12 March
2024
hjmjohnson pushed a commit to hjmjohnson/ITK that referenced this pull request May 12, 2026
…e-doxygen-config-in

STYLE: Remove doxygen.config.in (superseded by DoxygenConfig.cmake)
hjmjohnson pushed a commit to hjmjohnson/ITK that referenced this pull request May 12, 2026
nifti2_io.c was removed by:
- pull request InsightSoftwareConsortium#2630
commit 5895c80
"ENH: Prepare for update to NIFTILIB3.0.1", 9 July 2021

The two doxygen.config.in files were removed by:
- pull request InsightSoftwareConsortium#3311
commit 261b17a
"COMP: Use modern doxygen_add_docs command ITK_WRAP_DOCS", 11 March 2022
- pull request InsightSoftwareConsortium#4500
commit 8859699
"STYLE: Remove doxygen.config.in (superseded by DoxygenConfig.cmake)", 12 March
2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:Documentation Issues affecting the Documentation module type:Infrastructure Infrastructure/ecosystem related changes, such as CMake or buildbots type:Style Style changes: no logic impact (indentation, comments, naming)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants