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

DOC: Eliminate obsolete Doxygen grouping #7421

Merged
merged 7 commits into from Nov 24, 2023

Conversation

jcfr
Copy link
Member

@jcfr jcfr commented Nov 24, 2023

This removes the outdated Doxygen grouping, initially implemented to organize classes related to Slicer-specific modules or capabilities.

Since there were no systematic ways of checking that each modules were effectively associated with the correct group, the grouping was either incorrect or incomplete.

This removes all doxygen commands matching /ingroup and /defgroup

This commit removes the outdated Doxygen grouping, initially implemented
to organize classes related to specific loadable modules.

Since there were no systematic ways of checking that each classes were
effectively associated with the correct group, the grouping was
either incorrect or incomplete.

This removes all doxygen commands starting with either
`/ingroup Slicer_QtModules` or `/ingroup SlicerRt_QtModules`.
This commit removes the outdated Doxygen grouping, initially implemented
to organize classes related to either MRML nodes or MRML widgets.

Since there were no systematic ways of checking that each classes were
effectively associated with the correct group, the grouping was
either incorrect or incomplete.

This removes all doxygen commands matching the following:
* `/ingroup Slicer_MRMLWidgets`
* /ingroup Slicer_MRML_Core`
This commit removes the outdated Doxygen grouping, initially implemented
to organize classes related to Segmentation capabilities.

Since there were no systematic ways of checking that each classes were
effectively associated with the correct group, the grouping was
either incorrect or incomplete.

This removes all doxygen commands matching the following:
* `/ingroup SegmentationCore`
* `/ingroup Segmentations`
* `/ingroup vtkSegmentationCore`
This commit removes the outdated Doxygen grouping, initially implemented
to organize classes related to Slicer-specific CMake modules.

Since there were no systematic ways of checking that each modules were
effectively associated with the correct group, the grouping was
either incorrect or incomplete.

This removes all doxygen commands matching `/ingroup CMakeUtilities`
After copying and adapting the ITK classes based on the specific requirements
of either the vtkITK or ResampleDTIVolume modules, the grouping was not
relevant anymore.
@jcfr jcfr linked an issue Nov 24, 2023 that may be closed by this pull request
@jcfr jcfr requested review from lassoan and pieper November 24, 2023 17:33
@jcfr
Copy link
Member Author

jcfr commented Nov 24, 2023

Since these changes doesn't functionally impact the application and local compilation was successful, I will move forward with integration in the next hour.

@jcfr jcfr merged commit ed1e965 into Slicer:main Nov 24, 2023
5 checks passed
@jcfr jcfr deleted the cleanup-doxygen-grouping branch November 24, 2023 20:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Move definition of module doxygen group into module main header
1 participant