Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

STYLE: Separate \ingroup for MultiThreaded with AddImageFilter, PowImageFilter #4208

Merged

Conversation

thewtex
Copy link
Member

@thewtex thewtex commented Sep 7, 2023

Hopefully this will help with the Doxygen XML issues discussed at:
InsightSoftwareConsortium/ITKSphinxExamples#411.

…ageFilter

Hopefully this will help with the Doxygen XML issues discussed at:
InsightSoftwareConsortium/ITKSphinxExamples#411.
@github-actions github-actions bot added area:Filtering Issues affecting the Filtering module type:Style Style changes: no logic impact (indentation, comments, naming) labels Sep 7, 2023
@thewtex thewtex requested a review from jhlegarreta September 7, 2023 02:38
@thewtex thewtex requested review from dzenanz and tbirdso September 7, 2023 02:42
@dzenanz dzenanz merged commit 1ec8df8 into InsightSoftwareConsortium:master Sep 7, 2023
Copy link
Member

@jhlegarreta jhlegarreta left a comment

Choose a reason for hiding this comment

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

Yep, I had spot that, but had discarded the idea since I had found other appearances in ITK where a class is added to multiple groups being defined on the same \ingroup command. According to Doxygen, \ingroup allows to add multiple names on the same line:
https://www.doxygen.nl/manual/commands.html#cmdingroup

See

/** @ingroup group1 group2 group3 group4
 *  namespace N1 is in four groups
 *  @sa @link group1 The first group@endlink, group2, group3, group4 
 *
 *  Also see @ref mypage2
 */

in https://www.doxygen.nl/manual/grouping.html, and the corresponding documentation rendered in https://www.doxygen.nl/manual/examples/group/html/namespace_n1.html.

@jhlegarreta
Copy link
Member

The problems reported in InsightSoftwareConsortium/ITKSphinxExamples#411 persist, unfortunately:
https://itk.org/Doxygen/html/annotated.html

@thewtex thewtex deleted the doxygen-ingroup-add-pow branch November 3, 2023 21:41
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
area:Filtering Issues affecting the Filtering module type:Style Style changes: no logic impact (indentation, comments, naming)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants