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
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.
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 0 additions & 1 deletion Base/QTGUI/Testing/Cxx/qSlicerDataDialogTest1.cxx
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ class qSlicerDummyIOOptionsWidget
};

//-----------------------------------------------------------------------------
/// \ingroup Slicer_QtModules_Dummy
class qSlicerDummyIO: public qSlicerIO
{
public:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@
#include <vtkNew.h>

//-----------------------------------------------------------------------------
/// \ingroup Slicer_QtModules_Dummy
class qSlicerDummyFileWriter: public qSlicerFileWriter
{
public:
Expand Down
1 change: 0 additions & 1 deletion CMake/SlicerMacroSimpleTest.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
#! \sa https://www.cmake.org/cmake/help/cmake-2-8-docs.html#command:add_test
#! \sa https://www.cmake.org/cmake/help/cmake-2-8-docs.html#variable:PROJECT_NAME
#!
#! \ingroup CMakeUtilities
macro(simple_test testname)
set(options
)
Expand Down
6 changes: 6 additions & 0 deletions Docs/developer_guide/advanced_topics.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,12 @@ nodes = scene.GetNodesByClass("vtkMRMLModelNode")
nodes.UnRegister(None) # GetNodesByClass method is NOT marked with VTK_NEWINSTANCE, manual unregistration is needed
```

Here are the different naming conventions for such "factory" methods:
* `GetXXX`: Return an existing object, reference count is not changed, the caller is not responsible for the object.
* `NewXXX`: Solely instantiate an object (typically a factory method). The caller is responsible to decrement the reference count.
* `CreateXXX`: Instantiate and configure an object. The caller is responsible to decrement the reference count. If `XXX` is a MRML node, it is NOT added into the scene.
* `CreateAndAddXXX`: Instantiate, configure and add into the scene a MRML node. The caller is not responsible to decrement the reference count.

#### VTK_NEWINSTANCE wrapper hint

If a factory method is marked with the `VTK_NEWINSTANCE` hint then the ownership is transferred to Python where garbage collection takes care of deleting the object when it is no longer needed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@
#include "vtkSlicerLoadableModuleTemplateModuleLogicExport.h"


/// \ingroup Slicer_QtModules_ExtensionTemplate
class VTK_SLICER_LOADABLEMODULETEMPLATE_MODULE_LOGIC_EXPORT vtkSlicerLoadableModuleTemplateLogic :
public vtkSlicerModuleLogic
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
#include "ui_qSlicerLoadableModuleTemplateFooBarWidget.h"

//-----------------------------------------------------------------------------
/// \ingroup Slicer_QtModules_LoadableModuleTemplate
class qSlicerLoadableModuleTemplateFooBarWidgetPrivate
: public Ui_qSlicerLoadableModuleTemplateFooBarWidget
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@

class qSlicerLoadableModuleTemplateFooBarWidgetPrivate;

/// \ingroup Slicer_QtModules_LoadableModuleTemplate
class Q_SLICER_MODULE_LOADABLEMODULETEMPLATE_WIDGETS_EXPORT qSlicerLoadableModuleTemplateFooBarWidget
: public QWidget
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
#include "qSlicerLoadableModuleTemplateModuleWidget.h"

//-----------------------------------------------------------------------------
/// \ingroup Slicer_QtModules_ExtensionTemplate
class qSlicerLoadableModuleTemplateModulePrivate
{
public:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@

class qSlicerLoadableModuleTemplateModulePrivate;

/// \ingroup Slicer_QtModules_ExtensionTemplate
class Q_SLICER_QTMODULES_LOADABLEMODULETEMPLATE_EXPORT
qSlicerLoadableModuleTemplateModule
: public qSlicerLoadableModule
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
#include "ui_qSlicerLoadableModuleTemplateModuleWidget.h"

//-----------------------------------------------------------------------------
/// \ingroup Slicer_QtModules_ExtensionTemplate
class qSlicerLoadableModuleTemplateModuleWidgetPrivate: public Ui_qSlicerLoadableModuleTemplateModuleWidget
{
public:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
class qSlicerLoadableModuleTemplateModuleWidgetPrivate;
class vtkMRMLNode;

/// \ingroup Slicer_QtModules_ExtensionTemplate
class Q_SLICER_QTMODULES_LOADABLEMODULETEMPLATE_EXPORT qSlicerLoadableModuleTemplateModuleWidget :
public qSlicerAbstractModuleWidget
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@
#include "vtkSlicerSuperLoadableModuleTemplateModuleLogicExport.h"


/// \ingroup Slicer_QtModules_ExtensionTemplate
class VTK_SLICER_SUPERLOADABLEMODULETEMPLATE_MODULE_LOGIC_EXPORT vtkSlicerSuperLoadableModuleTemplateLogic :
public vtkSlicerModuleLogic
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
#include "ui_qSlicerSuperLoadableModuleTemplateFooBarWidget.h"

//-----------------------------------------------------------------------------
/// \ingroup Slicer_QtModules_SuperLoadableModuleTemplate
class qSlicerSuperLoadableModuleTemplateFooBarWidgetPrivate
: public Ui_qSlicerSuperLoadableModuleTemplateFooBarWidget
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@

class qSlicerSuperLoadableModuleTemplateFooBarWidgetPrivate;

/// \ingroup Slicer_QtModules_SuperLoadableModuleTemplate
class Q_SLICER_MODULE_SUPERLOADABLEMODULETEMPLATE_WIDGETS_EXPORT qSlicerSuperLoadableModuleTemplateFooBarWidget
: public QWidget
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
#include "qSlicerSuperLoadableModuleTemplateModuleWidget.h"

//-----------------------------------------------------------------------------
/// \ingroup Slicer_QtModules_ExtensionTemplate
class qSlicerSuperLoadableModuleTemplateModulePrivate
{
public:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@

class qSlicerSuperLoadableModuleTemplateModulePrivate;

/// \ingroup Slicer_QtModules_ExtensionTemplate
class Q_SLICER_QTMODULES_SUPERLOADABLEMODULETEMPLATE_EXPORT
qSlicerSuperLoadableModuleTemplateModule
: public qSlicerLoadableModule
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
#include "ui_qSlicerSuperLoadableModuleTemplateModuleWidget.h"

//-----------------------------------------------------------------------------
/// \ingroup Slicer_QtModules_ExtensionTemplate
class qSlicerSuperLoadableModuleTemplateModuleWidgetPrivate: public Ui_qSlicerSuperLoadableModuleTemplateModuleWidget
{
public:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
class qSlicerSuperLoadableModuleTemplateModuleWidgetPrivate;
class vtkMRMLNode;

/// \ingroup Slicer_QtModules_ExtensionTemplate
class Q_SLICER_QTMODULES_SUPERLOADABLEMODULETEMPLATE_EXPORT qSlicerSuperLoadableModuleTemplateModuleWidget :
public qSlicerAbstractModuleWidget
{
Expand Down
15 changes: 0 additions & 15 deletions Libs/MRML/Core/Documentation/MRMLCore.dox

This file was deleted.

1 change: 0 additions & 1 deletion Libs/MRML/Core/vtkMRMLLinearTransformSequenceStorageNode.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ enum SequenceFileType
NRRD_SEQUENCE_FILE
};

/// \ingroup Slicer_QtModules_Sequences
class VTK_MRML_EXPORT vtkMRMLLinearTransformSequenceStorageNode : public vtkMRMLNRRDStorageNode
{
public:
Expand Down
1 change: 0 additions & 1 deletion Libs/MRML/Core/vtkMRMLSegmentationDisplayNode.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ class vtkStringArray;
class vtkVector3d;


/// \ingroup Segmentations
/// \brief MRML node for representing segmentation display attributes.
///
/// vtkMRMLSegmentationDisplayNode nodes describe how volume is displayed.
Expand Down
1 change: 0 additions & 1 deletion Libs/MRML/Core/vtkMRMLSegmentationNode.h
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,6 @@ class vtkMRMLScalarVolumeNode;
class vtkPolyData;

/// \brief MRML node containing segmentations
/// \ingroup Segmentations
///
/// Segmentation node stores a set of segments (also known as contours or segmented regions).
/// Segments may overlap and may be stored in various representations (binary labelmap image,
Expand Down
1 change: 0 additions & 1 deletion Libs/MRML/Core/vtkMRMLStaticMeasurement.h
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
/// Typically all measurements calculate their own value from its input
/// MRML node. This class is to be able to store constant measurements.
///
/// \ingroup Slicer_QtModules_Markups
class VTK_MRML_EXPORT vtkMRMLStaticMeasurement : public vtkMRMLMeasurement
{
public:
Expand Down
1 change: 0 additions & 1 deletion Libs/MRML/Core/vtkMRMLSubjectHierarchyLegacyNode.h
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@
// STD includes
#include <map>

/// \ingroup Slicer_MRML_Core
/// \brief Legacy subject hierarchy node to allow loading older MRML scenes
///
/// Older MRML scenes contain per-item subject hierarchy nodes, which are incompatible
Expand Down
1 change: 0 additions & 1 deletion Libs/MRML/Core/vtkMRMLSubjectHierarchyNode.h
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ class vtkMRMLDisplayNode;
class vtkMRMLTransformNode;
class vtkMRMLAbstractViewNode;

/// \ingroup Slicer_MRML_Core
/// \brief MRML node to represent a complete subject hierarchy tree
///
/// There can be only one such node in the scene, as subject hierarchy is to contain all the supported
Expand Down
1 change: 0 additions & 1 deletion Libs/MRML/Core/vtkMRMLTextStorageNode.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
// MRML includes
#include <vtkMRMLStorageNode.h>

/// \ingroup Slicer_QtModules_Sequences
class VTK_MRML_EXPORT vtkMRMLTextStorageNode : public vtkMRMLStorageNode
{
public:
Expand Down
1 change: 0 additions & 1 deletion Libs/MRML/Core/vtkMRMLVolumeSequenceStorageNode.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
#include "vtkMRMLNRRDStorageNode.h"
#include <string>

/// \ingroup Slicer_QtModules_Sequences
class VTK_MRML_EXPORT vtkMRMLVolumeSequenceStorageNode : public vtkMRMLNRRDStorageNode
{
public:
Expand Down
1 change: 0 additions & 1 deletion Libs/MRML/Widgets/qMRMLSegmentSelectorWidget.h
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,6 @@ class QStringList;

/// \brief Qt widget for selecting a single segment from a segmentation.
/// If multiple segments are needed, then use \sa qMRMLSegmentsTableView instead in SimpleListMode
/// \ingroup SlicerRt_QtModules_Segmentations_Widgets
class QMRML_WIDGETS_EXPORT qMRMLSegmentSelectorWidget : public qMRMLWidget
{
Q_OBJECT
Expand Down
2 changes: 0 additions & 2 deletions Libs/vtkITK/itkConstrainedValueMultiplicationImageFilter.h
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,6 @@ namespace itk
*
* \author Lino Ramirez. Dept. of Electrical and Computer
* Engineering. University of Alberta. Canada
*
* \ingroup IntensityImageFilters Multithreaded
*/
namespace Functor {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
// VTK includes
#include <vtkPolyData.h>

/// \ingroup SegmentationCore
/// \brief Convert binary labelmap representation (vtkOrientedImageData type) to
/// closed surface representation (vtkPolyData type). The conversion algorithm
/// performs a marching cubes operation on the image data followed by an optional
Expand Down
1 change: 0 additions & 1 deletion Libs/vtkSegmentationCore/vtkCalculateOversamplingFactor.h
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@

class vtkPiecewiseFunction;

/// \ingroup SegmentationCore
/// \brief Calculate oversampling factor based on model properties using fuzzy logics
class vtkSegmentationCore_EXPORT vtkCalculateOversamplingFactor : public vtkObject
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@

class vtkPolyData;

/// \ingroup SegmentationCore
/// \brief Convert closed surface representation (vtkPolyData type) to binary
/// labelmap representation (vtkOrientedImageData type). The conversion algorithm
/// is based on image stencil.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@

class vtkPolyData;

/// \ingroup SegmentationCore
/// \brief Convert closed surface representation (vtkPolyData type) to fractional
/// labelmap representation (vtkOrientedImageData type). The conversion algorithm
/// is based on image stencil.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
#include "vtkSegmentationConverter.h"
#include "vtkSegmentationCoreConfigure.h"

/// \ingroup SegmentationCore
/// \brief Convert Fractional labelmap representation (vtkOrientedImageData type) to
/// closed surface representation (vtkPolyData type). The conversion algorithm
/// performs a marching cubes operation on the image data followed by an optional
Expand Down
1 change: 0 additions & 1 deletion Libs/vtkSegmentationCore/vtkOrientedImageData.h
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@

class vtkMatrix4x4;

/// \ingroup SegmentationCore
/// \brief Image data containing orientation information
///
/// This extends vtkImageData to arbitrary grid orientation.
Expand Down
1 change: 0 additions & 1 deletion Libs/vtkSegmentationCore/vtkOrientedImageDataResample.h
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ class vtkOrientedImageData;
class vtkTransform;
class vtkAbstractTransform;

/// \ingroup SegmentationCore
/// \brief Utility functions for resampling oriented image data
class vtkSegmentationCore_EXPORT vtkOrientedImageDataResample : public vtkObject
{
Expand Down
1 change: 0 additions & 1 deletion Libs/vtkSegmentationCore/vtkSegment.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@
// Segmentation includes
#include "vtkSegmentationCoreConfigure.h"

/// \ingroup SegmentationCore
/// \brief This class encapsulates a segment that is part of a segmentation
/// \details
/// A \sa vtkSegmentation can contain multiple segments (this class) each of which represent
Expand Down
1 change: 0 additions & 1 deletion Libs/vtkSegmentationCore/vtkSegmentation.h
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ class vtkIntArray;
class vtkSegmentationConversionPath;
class vtkStringArray;

/// \ingroup SegmentationCore
/// \brief This class encapsulates a segmentation that can contain multiple segments and multiple representations for each segment
/// \details
/// The primary purpose of this class is to serve as a container to store the segments (in labelmap analogy the "labels").
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
// Segmentation includes
#include "vtkSegmentationCoreConfigure.h"

/// \ingroup SegmentationCore
/// \brief Store a list of conversion parameters.
/// \details
/// Stores properties, such as name, description (that may be displayed
Expand Down
2 changes: 0 additions & 2 deletions Libs/vtkSegmentationCore/vtkSegmentationConversionPath.h
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@

class vtkSegmentationConverterRule;

/// \ingroup SegmentationCore
/// \brief Store a segmentation conversion path.
/// \details
/// Stores conversion path as a list of conversion rules and their parameters.
Expand Down Expand Up @@ -81,7 +80,6 @@ class vtkSegmentationCore_EXPORT vtkSegmentationConversionPath : public vtkObjec
};


/// \ingroup SegmentationCore
/// \brief Store multiple segmentation conversion paths.
/// \details
/// Stores multiple conversion paths, each defined by a list of segmentation conversion rules.
Expand Down
1 change: 0 additions & 1 deletion Libs/vtkSegmentationCore/vtkSegmentationConverter.h
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ class vtkMatrix4x4;
class vtkImageData;
class vtkOrientedImageData;

/// \ingroup SegmentationCore
/// \brief Class that can convert between different representations of a segment.
class vtkSegmentationCore_EXPORT vtkSegmentationConverter : public vtkObject
{
Expand Down
1 change: 0 additions & 1 deletion Libs/vtkSegmentationCore/vtkSegmentationConverterFactory.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@
class vtkSegmentationConverterRule;
class vtkDataObject;

/// \ingroup SegmentationCore
/// \brief Class that can create vtkSegmentationConverter instances.
///
/// This singleton class is a repository of all segmentation converter rules.
Expand Down
1 change: 0 additions & 1 deletion Libs/vtkSegmentationCore/vtkSegmentationConverterRule.h
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ class vtkSegment;
return newClass::New(); \
}
#endif
/// \ingroup SegmentationCore
/// \brief Abstract converter rule class. Subclasses perform conversions between specific
/// representation types. They define source and target type and provide ways to create those
/// types of objects.
Expand Down
1 change: 0 additions & 1 deletion Libs/vtkSegmentationCore/vtkSegmentationHistory.h
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ class vtkDataObject;
class vtkSegment;
class vtkSegmentation;

/// \ingroup SegmentationCore
class vtkSegmentationCore_EXPORT vtkSegmentationHistory : public vtkObject
{
public:
Expand Down
1 change: 0 additions & 1 deletion Libs/vtkSegmentationCore/vtkSegmentationModifier.h
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@
class vtkOrientedImageData;
class vtkSegmentation;

/// \ingroup SegmentationCore
/// \brief Utility functions for resampling oriented image data
class vtkSegmentationCore_EXPORT vtkSegmentationModifier : public vtkObject
{
Expand Down
1 change: 0 additions & 1 deletion Libs/vtkSegmentationCore/vtkTopologicalHierarchy.h
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@

class vtkIntArray;

/// \ingroup vtkSegmentationCore
/// \brief Algorithm class for computing topological hierarchy of multiple poly data models.
/// The levels of the models are determined according to the models they contain, an outer
/// model always having larger level value than the inner ones. To determine whether a model
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,6 @@ namespace itk
* adds the absolute value of the difference between the different components
* of the diffusion tensor. It compares the sum to a threshold set by the
* developer
*
* \ingroup IntensityImageFilters Multithreaded
*/
template <class TInputImage, class TOutputImage>
class DifferenceDiffusionTensor3DImageFilter :
Expand Down