Merge branch 'doxygen-improvements'

* doxygen-improvements:
  Converted CommandLineParser example code to a compilable snippet.
  Removed HTML commands in the PROJECT_BRIEF variable.
  Exclude Visualization/XIP from doxygen sources.
  Added more doxygen groups and \ingroup commands.

Documentation/CTKMainPage.dox

@@ -4,12 +4,41 @@
 
 \section intro_sec Introduction
 
+The goal of CTK is to support biomedical image computing. CTK code is licensed
+under <a href="http://www.apache.org/licenses/LICENSE-2.0.html">Apache 2.0</a>.
+
+CTK works on topics that are not covered by existing toolkits that support the
+mutual interest and needs of the CTK community. The main scope of current CTK
+efforts includes the following topics:
+
+ - \ref Project_DICOM
+ - \ref Project_DICOMAppHosting
+ - \ref Project_Widgets
+ - \ref PluginFramework
+
 See the <a href="http://www.commontk.org">CTK Wiki</a> for more information.
 
-\defgroup Apps CTK Applications
+\defgroup Apps Applications
+
+\defgroup Libs Libraries
+
+\defgroup Plugins Plugins
+
+\defgroup Projects Projects
+The Common Toolkit focuses its efforts on the following main projects.
+
+- \ref Project_DICOM
+- \ref Project_DICOMAppHosting
+- \ref Project_Widgets
+- \ref PluginFramework
+
+\defgroup Project_DICOM DICOM
+\ingroup Projects
 
-\defgroup Libs CTK Libraries
+\defgroup Project_DICOMAppHosting DICOM Application Hosting
+\ingroup Projects
 
-\defgroup Plugins CTK Plugins
+\defgroup Project_Widgets Widgets
+\ingroup Projects
 
 */

Documentation/Doxyfile.txt.in

@@ -35,7 +35,7 @@ PROJECT_NUMBER         = @CTK_VERSION@
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description for a project that appears at the top of each page and should give viewer a quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          = "The <a href=\"http://www.commontk.org\">Common Toolkit</a> is a community effort to provide support code for medical image analysis, surgical navigation, and related projects."
+PROJECT_BRIEF          = "The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects."
 
 # With the PROJECT_LOGO tag one can specify an logo or icon that is
 # included in the documentation. The maximum height of the logo should not
@@ -685,7 +685,8 @@ RECURSIVE              = YES
 EXCLUDE                = @CTK_BINARY_DIR@ \
                          @CTK_SOURCE_DIR@/Utilities \
                          @CTK_SOURCE_DIR@/CMake/ctkDashboardDriverScript.cmake \
-                         @CTK_SOURCE_DIR@/CMake/ctkDashboardScript.TEMPLATE.cmake
+                         @CTK_SOURCE_DIR@/CMake/ctkDashboardScript.TEMPLATE.cmake \
+                         @CTK_SOURCE_DIR@/Libs/Visualization/XIP
 
 # The EXCLUDE_SYMLINKS tag can be used select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded
@@ -720,7 +721,8 @@ EXCLUDE_SYMBOLS        =
 # directories that contain example code fragments that are included (see
 # the \include command).
 
-EXAMPLE_PATH           = @CTK_SOURCE_DIR@/Libs/PluginFramework/Documentation/Snippets/
+EXAMPLE_PATH           = @CTK_SOURCE_DIR@/Libs/Core/Documentation/Snippets/ \
+                         @CTK_SOURCE_DIR@/Libs/PluginFramework/Documentation/Snippets/
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp

Libs/Core/CMakeLists.txt

@@ -134,4 +134,7 @@ endif()
 # Testing
 if(BUILD_TESTING)
   add_subdirectory(Testing)
+  
+  # Compile source code snippets
+  add_subdirectory(Documentation/Snippets)
 endif()

Libs/Core/Documentation/CTKCore.dox

@@ -1,5 +1,5 @@
 /**
-\defgroup Core CTK Core
+\defgroup Core Core
 \ingroup Libs
 The CTK Core library provides generally useful utility classes.
 

Libs/Core/Documentation/Snippets/CMakeLists.txt

@@ -0,0 +1,4 @@
+if(BUILD_TESTING)
+  include_directories(${CTKCore_SOURCE_DIR})
+  ctkFunctionCompileSnippets("${CMAKE_CURRENT_SOURCE_DIR}" CTKCore)
+endif()

Libs/Core/Documentation/Snippets/CommandLineParser/main.cpp

@@ -0,0 +1,48 @@
+//! [0]
+#include <ctkCommandLineParser.h>
+
+#include <QCoreApplication>
+#include <QTextStream>
+
+#include <cstdlib>
+
+int main(int argc, char** argv)
+{
+  QCoreApplication app(argc, argv);
+  // This is used by QSettings
+  QCoreApplication::setOrganizationName("MyOrg");
+  QCoreApplication::setApplicationName("MyApp");
+
+  ctkCommandLineParser parser;
+  // Use Unix-style argument names
+  parser.setArgumentPrefix("--", "-");
+  // Enable QSettings support
+  parser.enableSettings("disable-settings");
+
+  // Add command line argument names
+  parser.addArgument("disable-settings", "", QVariant::Bool, "Do not use QSettings");
+  parser.addArgument("help", "h", QVariant::Bool, "Show this help text");
+  parser.addArgument("search-paths", "s", QVariant::StringList, "A list of paths to search");
+
+  // Parse the command line arguments
+  bool ok = false;
+  QHash<QString, QVariant> parsedArgs = parser.parseArguments(QCoreApplication::arguments(), &ok);
+  if (!ok)
+  {
+    QTextStream(stderr, QIODevice::WriteOnly) << "Error parsing arguments: "
+                                              << parser.errorString() << "\n";
+    return EXIT_FAILURE;
+  }
+
+  // Show a help message
+  if (parsedArgs.contains("help") || parsedArgs.contains("h"))
+  {
+    QTextStream(stdout, QIODevice::WriteOnly) << parser.helpText();
+    return EXIT_SUCCESS;
+  }
+
+  // Do something
+
+  return EXIT_SUCCESS;
+}
+//! [0]

Libs/Core/ctkCallback.h

@@ -28,6 +28,7 @@
 #include "ctkCoreExport.h"
 
 //---------------------------------------------------------------------------
+/// \ingroup Core
 /// The following example prints debug statement everytime the current value
 /// of the slider is changed:
 /// void print() { qDebug() << "signal called"; }

Libs/Core/ctkCheckableModelHelper.h

@@ -62,6 +62,7 @@ class QAbstractItemModel;
 
 class ctkCheckableModelHelperPrivate;
 
+/// \ingroup Core
 ///
 /// ctkCheckableModelHelper expose functions to handle checkable models
 class CTK_CORE_EXPORT ctkCheckableModelHelper : public QObject

Libs/Core/ctkCommandLineParser.h

@@ -57,51 +57,7 @@ class QSettings;
  *
  * Here is an example how to use this class inside a main function:
  *
- * \code
- * #include <ctkCommandLineParser.h>
- * #include <QCoreApplication>
- * #include <QTextStream>
- *
- * int main(int argc, char** argv)
- * {
- *   QCoreApplication app(argc, argv);
- *   // This is used by QSettings
- *   QCoreApplication::setOrganizationName("MyOrg");
- *   QCoreApplication::setApplicationName("MyApp");
- *
- *   ctkCommandLineParser parser;
- *   // Use Unix-style argument names
- *   parser.setArgumentPrefix("--", "-");
- *   // Enable QSettings support
- *   parser.enableSettings("disable-settings");
- *
- *   // Add command line argument names
- *   parser.addArgument("disable-settings", "", QVariant::Bool, "Do not use QSettings");
- *   parser.addArgument("help", "h", QVariant::Bool, "Show this help text");
- *   parser.addArgument("search-paths", "s", QVariant::StringList, "A list of paths to search");
- *
- *   // Parse the command line arguments
- *   bool ok = false;
- *   QHash<QString, QVariant> parsedArgs = parser.parseArguments(QCoreApplication::arguments(), &ok);
- *   if (!ok)
- *   {
- *     QTextStream(stderr, QIODevice::WriteOnly) << "Error parsing arguments: "
- *                                               << parser.errorString() << "\n";
- *     return EXIT_FAILURE;
- *   }
- *
- *   // Show a help message
- *   if (parsedArgs.contains("help") || parsedArgs.contains("h"))
- *   {
- *     QTextStream(stdout, QIODevice::WriteOnly) << parser.helpText();
- *     return EXIT_SUCCESS;
- *   }
- *
- *   // Do something
- *
- *   return EXIT_SUCCESS;
- * }
- * \endcode
+ * \snippet CommandLineParser/main.cpp 0
  */
 class CTK_CORE_EXPORT ctkCommandLineParser : public QObject
 {

Libs/Core/ctkErrorLogFDMessageHandler.h

@@ -28,6 +28,7 @@
 class ctkErrorLogFDMessageHandlerPrivate;
 
 //------------------------------------------------------------------------------
+/// \ingroup Core
 class CTK_CORE_EXPORT ctkErrorLogFDMessageHandler : public ctkErrorLogAbstractMessageHandler
 {
 public:

Libs/Core/ctkErrorLogFDMessageHandler_p.h

@@ -38,6 +38,7 @@ class QTextStream;
 // ctkFDHandler
 
 // --------------------------------------------------------------------------
+/// \ingroup Core
 class ctkFDHandler : public QThread
 {
   Q_OBJECT

Libs/Core/ctkErrorLogModel.h

@@ -29,6 +29,7 @@
 #include "ctkCoreExport.h"
 
 //------------------------------------------------------------------------------
+/// \ingroup Core
 class CTK_CORE_EXPORT ctkErrorLogLevel : public QObject
 {
   Q_OBJECT
@@ -61,6 +62,7 @@ Q_DECLARE_OPERATORS_FOR_FLAGS(ctkErrorLogLevel::LogLevels)
 class ctkErrorLogTerminalOutputPrivate;
 
 //------------------------------------------------------------------------------
+/// \ingroup Core
 class CTK_CORE_EXPORT ctkErrorLogTerminalOutput
 {
 public:
@@ -88,6 +90,7 @@ class ctkErrorLogAbstractMessageHandler;
 class ctkErrorLogModelPrivate;
 
 //------------------------------------------------------------------------------
+/// \ingroup Core
 class CTK_CORE_EXPORT ctkErrorLogModel : public QSortFilterProxyModel
 {
   Q_OBJECT
@@ -186,6 +189,7 @@ Q_DECLARE_OPERATORS_FOR_FLAGS(ctkErrorLogModel::TerminalOutputs)
 class ctkErrorLogAbstractMessageHandlerPrivate;
 
 //------------------------------------------------------------------------------
+/// \ingroup Core
 class CTK_CORE_EXPORT ctkErrorLogAbstractMessageHandler : public QObject
 {
   Q_OBJECT

Libs/Core/ctkErrorLogQtMessageHandler.h

@@ -26,6 +26,7 @@
 #include "ctkCoreExport.h"
 
 //------------------------------------------------------------------------------
+/// \ingroup Core
 class CTK_CORE_EXPORT ctkErrorLogQtMessageHandler : public ctkErrorLogAbstractMessageHandler
 {
 public:

Libs/Core/ctkErrorLogStreamMessageHandler.h

@@ -28,6 +28,7 @@
 class ctkErrorLogStreamMessageHandlerPrivate;
 
 //------------------------------------------------------------------------------
+/// \ingroup Core
 class CTK_CORE_EXPORT ctkErrorLogStreamMessageHandler
   : public ctkErrorLogAbstractMessageHandler
 {

Libs/DICOM/Core/ctkDICOMAbstractThumbnailGenerator.h

@@ -30,6 +30,7 @@
 class ctkDICOMAbstractThumbnailGeneratorPrivate;
 class DicomImage;
 
+/// \ingroup DICOM_Core
 ///
 /// \brief Abstract thumbnail generator class
 ///

Libs/DICOM/Core/ctkDICOMCorePythonQtDecorators.h

@@ -33,7 +33,7 @@
 // for non-static methods.
 //
 
-/// \ingroup DICOMCore
+/// \ingroup DICOM_Core
 class ctkDICOMCorePythonQtDecorators : public QObject
 {
   Q_OBJECT

Libs/DICOM/Core/ctkDICOMDatabase.h

@@ -33,7 +33,8 @@ class ctkDICOMDatabasePrivate;
 class DcmDataset;
 class ctkDICOMAbstractThumbnailGenerator;
 
-
+/// \ingroup DICOM_Core
+///
 /// Class handling a database of DICOM objects. So far, an underlying
 /// SQLITE database is used for that. Usually, added DICOM objects are also
 /// stored within the file system.

Libs/DICOM/Core/ctkDICOMDataset.h

@@ -33,6 +33,9 @@ class DcmDataDictionary;
 
 
 class ctkDICOMDatasetPrivate;
+
+/// \ingroup DICOM_Core
+///
 ///  \brief Base class for DICOM objects and interface with DICOM toolkit DCMTK.
 ///
 ///  This class serves as the base class for all DICOM objects (patient, study, series, image).

Libs/DICOM/Core/ctkDICOMFilterProxyModel.h

@@ -28,6 +28,7 @@
 
 class ctkDICOMFilterProxyModelPrivate;
 
+/// \ingroup DICOM_Core
 class CTK_DICOM_CORE_EXPORT ctkDICOMFilterProxyModel : public QSortFilterProxyModel{
     Q_OBJECT
 

Libs/DICOM/Core/ctkDICOMIndexer.h

@@ -30,6 +30,7 @@
 
 class ctkDICOMIndexerPrivate;
 
+/// \ingroup DICOM_Core
 ///
 /// \brief Indexes DICOM images located in local directory into an Sql database
 ///

Libs/DICOM/Core/ctkDICOMModel.h

@@ -30,6 +30,8 @@
 #include "ctkDICOMCoreExport.h"
 
 class ctkDICOMModelPrivate;
+
+/// \ingroup DICOM_Core
 class CTK_DICOM_CORE_EXPORT ctkDICOMModel
 //  : public QStandardItemModel
   : public QAbstractItemModel

Libs/DICOM/Core/ctkDICOMPersonName.h

@@ -31,6 +31,8 @@
 #include <string>
 
 class ctkDICOMPersonNameData;
+
+/// \ingroup DICOM_Core
 ///
 /// \brief A person's name as modelled in DICOM.
 ///

Libs/DICOM/Core/ctkDICOMQuery.h

@@ -34,6 +34,8 @@
 #include "ctkDICOMDatabase.h"
 
 class ctkDICOMQueryPrivate;
+
+/// \ingroup DICOM_Core
 class CTK_DICOM_CORE_EXPORT ctkDICOMQuery : public QObject
 {
   Q_OBJECT

Libs/DICOM/Core/ctkDICOMRetrieve.h

@@ -33,6 +33,8 @@
 #include "ctkDICOMDatabase.h"
 
 class ctkDICOMRetrievePrivate;
+
+/// \ingroup DICOM_Core
 class CTK_DICOM_CORE_EXPORT ctkDICOMRetrieve : public QObject
 {
   Q_OBJECT

Libs/DICOM/Core/ctkDICOMTester.h

@@ -29,6 +29,8 @@ class QProcess;
 #include "ctkDICOMCoreExport.h"
 class ctkDICOMTesterPrivate;
 
+/// \ingroup DICOM_Core
+///
 /// \brief Utility class to test DICOM network applications
 /// A simple DICOM archive server can be run (startDCMQRSCP()), and images
 /// can be stored into the server using storeData(). It internally uses

Libs/DICOM/Documentation/CTKDICOM.dox

@@ -0,0 +1,12 @@
+/**
+
+\defgroup DICOM_Core DICOM Core
+\ingroup Libs
+\ingroup Project_DICOM
+
+\defgroup DICOM_Widgets DICOM Widgets
+\ingroup Libs
+\ingroup Project_DICOM
+\ingroup Project_Widgets
+
+*/

Libs/DICOM/Widgets/ctkDICOMAppWidget.h

@@ -30,6 +30,7 @@ class ctkDICOMAppWidgetPrivate;
 class ctkThumbnailLabel;
 class QModelIndex;
 
+/// \ingroup DICOM_Widgets
 class CTK_DICOM_WIDGETS_EXPORT ctkDICOMAppWidget : public QWidget
 {
   Q_OBJECT

Libs/DICOM/Widgets/ctkDICOMDatasetView.h

@@ -34,6 +34,7 @@
 class ctkDICOMDatasetViewPrivate;
 class DicomImage;
 
+/// \ingroup DICOM_Widgets
 ///
 /// ctkDICOMDatasetView is the base class of image viewer widgets.
 class CTK_DICOM_WIDGETS_EXPORT ctkDICOMDatasetView

Libs/DICOM/Widgets/ctkDICOMDirectoryListWidget.h

@@ -31,6 +31,7 @@
 
 class ctkDICOMDirectoryListWidgetPrivate;
 
+/// \ingroup DICOM_Widgets
 class CTK_DICOM_WIDGETS_EXPORT ctkDICOMDirectoryListWidget : public QWidget
 {
   Q_OBJECT

Libs/DICOM/Widgets/ctkDICOMImage.h

@@ -31,6 +31,7 @@
 class ctkDICOMImagePrivate;
 class DicomImage;
 
+/// \ingroup DICOM_Widgets
 ///
 /// \brief Wrapper around a DCMTK DicomImage.
 ///

Libs/DICOM/Widgets/ctkDICOMImportWidget.h

@@ -30,6 +30,7 @@ class ctkDICOMImportWidgetPrivate;
 
 class ctkDICOMDatabase;
 
+/// \ingroup DICOM_Widgets
 class CTK_DICOM_WIDGETS_EXPORT ctkDICOMImportWidget : public QWidget
 {
   Q_OBJECT

Libs/DICOM/Widgets/ctkDICOMItemTreeModel.h

@@ -29,6 +29,7 @@
 
 class ctkDICOMItemTreeModelPrivate;
 
+/// \ingroup DICOM_Widgets
 class CTK_DICOM_WIDGETS_EXPORT ctkDICOMItemTreeModel : public QAbstractItemModel
 {
 public:

Libs/DICOM/Widgets/ctkDICOMListenerWidget.h

@@ -28,6 +28,7 @@
 
 class ctkDICOMListenerWidgetPrivate;
 
+/// \ingroup DICOM_Widgets
 class CTK_DICOM_WIDGETS_EXPORT ctkDICOMListenerWidget : public QWidget
 {
 public:

Libs/DICOM/Widgets/ctkDICOMQueryResultsTabWidget.h

@@ -28,6 +28,7 @@
 
 #include "ctkDICOMWidgetsExport.h"
 
+/// \ingroup DICOM_Widgets
 class CTK_DICOM_WIDGETS_EXPORT ctkDICOMQueryResultsTabWidget : public QTabWidget
 {
 public:

Libs/DICOM/Widgets/ctkDICOMQueryRetrieveWidget.h

@@ -33,6 +33,7 @@
 
 class ctkDICOMQueryRetrieveWidgetPrivate;
 
+/// \ingroup DICOM_Widgets
 class CTK_DICOM_WIDGETS_EXPORT ctkDICOMQueryRetrieveWidget : public QWidget
 {
 Q_OBJECT;

Libs/DICOM/Widgets/ctkDICOMQueryWidget.h

@@ -28,6 +28,7 @@
 
 class ctkDICOMQueryWidgetPrivate;
 
+/// \ingroup DICOM_Widgets
 class CTK_DICOM_WIDGETS_EXPORT ctkDICOMQueryWidget : public QWidget
 {
     Q_OBJECT

Libs/DICOM/Widgets/ctkDICOMServerNodeWidget.h

@@ -32,6 +32,7 @@
 class QTableWidgetItem;
 class ctkDICOMServerNodeWidgetPrivate;
 
+/// \ingroup DICOM_Widgets
 class CTK_DICOM_WIDGETS_EXPORT ctkDICOMServerNodeWidget : public QWidget
 {
 Q_OBJECT;

Libs/DICOM/Widgets/ctkDICOMThumbnailGenerator.h

@@ -29,6 +29,7 @@
 class ctkDICOMThumbnailGeneratorPrivate;
 class DicomImage;
 
+/// \ingroup DICOM_Widgets
 ///
 /// \brief  thumbnail generator class
 ///

Libs/DICOM/Widgets/ctkDICOMThumbnailListWidget.h

@@ -28,6 +28,7 @@ class QModelIndex;
 class ctkDICOMThumbnailListWidgetPrivate;
 class ctkThumbnailWidget;
 
+/// \ingroup DICOM_Widgets
 class CTK_DICOM_WIDGETS_EXPORT ctkDICOMThumbnailListWidget : public ctkThumbnailListWidget
 {
   Q_OBJECT

Libs/DICOM/Widgets/ctkDICOMWidgetsPythonQtDecorators.h

@@ -33,7 +33,7 @@
 // for non-static methods.
 //
 
-/// \ingroup DICOMWidgets
+/// \ingroup DICOM_Widgets
 class ctkDICOMWidgetsPythonQtDecorators : public QObject
 {
   Q_OBJECT

Libs/ImageProcessing/Documentation/CTKImageProcessing.dox

@@ -0,0 +1,7 @@
+/**
+
+\defgroup ImageProcessing_ITK_Core ImageProcessing ITK Core
+\ingroup Libs
+
+
+*/

Libs/ImageProcessing/ITK/Core/ctkITKErrorLogMessageHandler.h

@@ -31,6 +31,7 @@
 
 class ctkITKErrorLogMessageHandlerPrivate;
 
+/// \ingroup ImageProcessing_ITK_Core
 class CTK_IMAGEPROCESSING_ITK_CORE_EXPORT ctkITKErrorLogMessageHandler :
     public ctkErrorLogAbstractMessageHandler
 {

Libs/PluginFramework/Documentation/CTKPluginFramework.dox

@@ -1,6 +1,9 @@
 /**
-\defgroup PluginFramework CTK Plugin Framework
+
+\defgroup PluginFramework Plugin Framework
 \ingroup Libs
+\ingroup Projects
+
 The CTK Plugin Framework is an OSGi like modularization framework for building
 cross-platform, dynamic, and modular applications. See
 <a href="http://www.commontk.org/index.php/Documentation/Plugin_Framework">

Libs/Scripting/Documentation/CTKScripting.dox

@@ -0,0 +1,9 @@
+/**
+
+\defgroup Scripting_Python_Core Scripting Python Core
+\ingroup Libs
+
+\defgroup Scripting_Python_Widgets Scripting Python Widgets
+\ingroup Libs
+
+*/

Libs/Scripting/Python/Core/ctkAbstractPythonManager.h

@@ -31,6 +31,7 @@
 
 class PythonQtObjectPtr;
 
+/// \ingroup Scripting_Python_Core
 class CTK_SCRIPTING_PYTHON_CORE_EXPORT ctkAbstractPythonManager : public QObject
 {
   Q_OBJECT

Libs/Scripting/Python/Core/ctkScriptingPythonCoreConfigure.h.in

@@ -2,9 +2,10 @@
 #define __ctkScriptingPythonCoreConfigure_h
 
 
+/// \ingroup Scripting_Python_Core
 ///
 /// Here is where system computed values get stored
-///
+/// {@
 
 #cmakedefine CTK_PYTHONQT_WRAP_QTCORE
 #cmakedefine CTK_PYTHONQT_WRAP_QTGUI
@@ -17,4 +18,6 @@
 #cmakedefine CTK_PYTHONQT_WRAP_QTXML
 #cmakedefine CTK_PYTHONQT_WRAP_QTXMLPATTERNS
 
+/// @}
+
 #endif

Libs/Scripting/Python/Widgets/ctkPythonConsole.h

@@ -55,7 +55,7 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 #include <ctkConsole.h>
 #include "ctkScriptingPythonWidgetsExport.h"
 
-
+/// \ingroup Scripting_Python_Widgets
 ///
 ///  Qt widget that provides an interactive "shell" interface to an embedded Python interpreter.
 ///  You can put an instance of ctkPythonConsole in a dialog or a window, and the user will be able

Libs/Visualization/Documentation/CTKVisualization.dox

@@ -0,0 +1,14 @@
+/**
+
+\defgroup Visualization_VTK_Core Visualization VTK Core
+\ingroup Libs
+
+\defgroup Visualization_VTK_Widgets Visualization VTK Widgets
+\ingroup Libs
+\ingroup Project_Widgets
+
+\defgroup Visualization_XIP Visualization XIP
+\ingroup Libs
+
+
+*/

Libs/Visualization/VTK/Core/ctkVTKColorTransferFunction.h

@@ -30,6 +30,7 @@
 class vtkColorTransferFunction;
 class ctkVTKColorTransferFunctionPrivate;
 
+/// \ingroup Visualization_VTK_Core
 ///
 /// Transfer function for a vtkColorTransferFunction. 
 /// The value is an RGB QColor (no alpha supported)

Libs/Visualization/VTK/Core/ctkVTKCompositeFunction.h

@@ -31,6 +31,7 @@ class vtkPiecewiseFunction;
 class vtkColorTransferFunction;
 class ctkVTKCompositeFunctionPrivate;
 
+/// \ingroup Visualization_VTK_Core
 ///
 /// Transfer function for a vtkPiecewiseFunction
 

Libs/Visualization/VTK/Core/ctkVTKConnection.h

@@ -34,6 +34,7 @@ class vtkObject;
 class ctkVTKConnectionPrivate;
 class vtkCallbackCommand;
 
+/// \ingroup Visualization_VTK_Core
 /// Warning the slot must have its signature order:
 /// vtkObject*, vtkObject* : sender, callData
 /// or
@@ -125,6 +126,7 @@ private:
   friend QDebug operator<<(QDebug dbg, const ctkVTKConnection& connection);
 };
 
+/// \ingroup Visualization_VTK_Core
 QDebug operator<<(QDebug dbg, const ctkVTKConnection& connection);
 
 #endif

Libs/Visualization/VTK/Core/ctkVTKConnection_p.h

@@ -34,6 +34,7 @@ class vtkObject;
 class vtkCallbackCommand;
 
 //-----------------------------------------------------------------------------
+/// \ingroup Visualization_VTK_Core
 class ctkVTKConnectionPrivate
 {
   Q_DECLARE_PUBLIC(ctkVTKConnection);

Libs/Visualization/VTK/Core/ctkVTKErrorLogMessageHandler.h

@@ -31,6 +31,7 @@
 
 class ctkVTKErrorLogMessageHandlerPrivate;
 
+/// \ingroup Visualization_VTK_Core
 class CTK_VISUALIZATION_VTK_CORE_EXPORT ctkVTKErrorLogMessageHandler :
     public ctkErrorLogAbstractMessageHandler
 {

Libs/Visualization/VTK/Core/ctkVTKHistogram.h

@@ -30,6 +30,7 @@
 class vtkDataArray;
 class ctkVTKHistogramPrivate;
 
+/// \ingroup Visualization_VTK_Core
 ///
 /// Transfer function for a vtkColorTransferFunction. 
 /// The value is an RGB QColor (no alpha supported)

Libs/Visualization/VTK/Core/ctkVTKLookupTable.h

@@ -30,6 +30,7 @@
 class vtkLookupTable;
 class ctkVTKLookupTablePrivate;
 
+/// \ingroup Visualization_VTK_Core
 ///
 /// Transfer function for a vtkColorTransferFunction. 
 /// The value is an RGB QColor (no alpha supported)

Libs/Visualization/VTK/Core/ctkVTKObject.h

@@ -21,9 +21,12 @@
 #ifndef __ctkVTKObject_h
 #define __ctkVTKObject_h
 
-/// ctkVTK includes
+// ctkVTK includes
 #include "ctkVTKObjectEventsObserver.h"
 
+/// \ingroup Visualization_VTK_Core
+/// @{
+
 //-----------------------------------------------------------------------------
 #define QVTK_OBJECT_ADD_CONNECTION_METHOD                               \
 QString qvtkConnect(vtkObject* vtk_obj, unsigned long vtk_event,        \
@@ -146,4 +149,6 @@ protected:                                         \
 private:                                           \
   ctkVTKObjectEventsObserver MyQVTK;
 
+/// @}
+
 #endif

Libs/Visualization/VTK/Core/ctkVTKObjectEventsObserver.h

@@ -40,6 +40,7 @@ class ctkVTKObjectEventsObserver;
 class ctkVTKObjectEventsObserverPrivate;
 
 //-----------------------------------------------------------------------------
+/// \ingroup Visualization_VTK_Core
 class CTK_VISUALIZATION_VTK_CORE_EXPORT ctkVTKConnectionFactory
 {
 public:
@@ -58,6 +59,7 @@ protected:
 CTK_SINGLETON_DECLARE_INITIALIZER(CTK_VISUALIZATION_VTK_CORE_EXPORT, ctkVTKConnectionFactory)
 
 //-----------------------------------------------------------------------------
+/// \ingroup Visualization_VTK_Core
 class CTK_VISUALIZATION_VTK_CORE_EXPORT ctkVTKObjectEventsObserver : public QObject
 {
 Q_OBJECT

Libs/Visualization/VTK/Core/ctkVTKPiecewiseFunction.h

@@ -30,6 +30,7 @@
 class vtkPiecewiseFunction;
 class ctkVTKPiecewiseFunctionPrivate;
 
+/// \ingroup Visualization_VTK_Core
 ///
 /// Transfer function for a vtkPiecewiseFunction
 

Libs/Visualization/VTK/Core/vtkLightBoxRendererManager.h

@@ -31,6 +31,7 @@ class vtkImageData;
 class vtkCamera;
 class vtkCornerAnnotation;
 
+/// \ingroup Visualization_VTK_Core
 class CTK_VISUALIZATION_VTK_CORE_EXPORT vtkLightBoxRendererManager : public vtkObject
 {
   vtkTypeRevisionMacro(vtkLightBoxRendererManager,vtkObject);

Libs/Visualization/VTK/Widgets/ctkVTKAbstractMatrixWidget.h

@@ -30,6 +30,7 @@
 class vtkMatrix4x4;
 class ctkVTKAbstractMatrixWidgetPrivate;
 
+/// \ingroup Visualization_VTK_Widgets
 /// This base class is primarily used by ctkVTKMatrixWidget but can be the base
 /// of other classes (ctkVTKTransformWidget?) that don't want to expose
 /// setMatrix() publicly.

Libs/Visualization/VTK/Widgets/ctkVTKAbstractMatrixWidget_p.h

@@ -33,6 +33,7 @@
 
 class vtkMatrix4x4;
 
+/// \ingroup Visualization_VTK_Widgets
 class ctkVTKAbstractMatrixWidgetPrivate: public QObject
 {
   Q_OBJECT

Libs/Visualization/VTK/Widgets/ctkVTKAbstractView.h

@@ -37,6 +37,7 @@ class vtkInteractorObserver;
 class vtkRenderWindowInteractor;
 class vtkRenderWindow;
 
+/// \ingroup Visualization_VTK_Widgets
 class CTK_VISUALIZATION_VTK_WIDGETS_EXPORT ctkVTKAbstractView : public QWidget
 {
   Q_OBJECT

Libs/Visualization/VTK/Widgets/ctkVTKAbstractView_p.h

@@ -37,6 +37,7 @@ class QTimer;
 #include <vtkWeakPointer.h>
 
 //-----------------------------------------------------------------------------
+/// \ingroup Visualization_VTK_Widgets
 class ctkVTKAbstractViewPrivate : public QObject
 {
   Q_OBJECT

Libs/Visualization/VTK/Widgets/ctkVTKChartView.h

@@ -33,6 +33,7 @@ class vtkChartXY;
 class vtkContextScene;
 class vtkPlot;
 
+/// \ingroup Visualization_VTK_Widgets
 class CTK_VISUALIZATION_VTK_WIDGETS_EXPORT ctkVTKChartView : public QVTKWidget
 {
   Q_OBJECT

Libs/Visualization/VTK/Widgets/ctkVTKDataSetArrayComboBox.h

@@ -31,6 +31,7 @@ class ctkVTKDataSetArrayComboBoxPrivate;
 class vtkDataArray;
 class vtkDataSet;
 
+/// \ingroup Visualization_VTK_Widgets
 ///
 /// QComboBox linked to vtkDataSet field arrays
 class CTK_VISUALIZATION_VTK_WIDGETS_EXPORT ctkVTKDataSetArrayComboBox : public QComboBox

Libs/Visualization/VTK/Widgets/ctkVTKDataSetModel.h

@@ -33,6 +33,7 @@
 class vtkDataSet;
 class vtkDataArray;
 
+/// \ingroup Visualization_VTK_Widgets
 namespace ctkVTK
 {
  enum ItemDataRole {
@@ -43,6 +44,7 @@ namespace ctkVTK
 class ctkVTKDataSetModelPrivate;
 
 //------------------------------------------------------------------------------
+/// \ingroup Visualization_VTK_Widgets
 class CTK_VISUALIZATION_VTK_WIDGETS_EXPORT ctkVTKDataSetModel
   : public QStandardItemModel
 {

Libs/Visualization/VTK/Widgets/ctkVTKMagnifyView.h

@@ -33,6 +33,7 @@ class QVTKWidget;
 
 class ctkVTKMagnifyViewPrivate;
 
+/// \ingroup Visualization_VTK_Widgets
 /// Gives a magnified view of a QVTKWidget around the mouse position, with
 /// overlaid crosshair (ex. cross-hair).  You must specify the QVTKWidget(s) to be
 /// observed.

Libs/Visualization/VTK/Widgets/ctkVTKMagnifyView_p.h

@@ -33,6 +33,7 @@ class QTimerEvent;
 // VTK includes
 class QVTKWidget;
 
+/// \ingroup Visualization_VTK_Widgets
 class ctkVTKMagnifyViewPrivate : public QObject
 {
   Q_OBJECT

Libs/Visualization/VTK/Widgets/ctkVTKMatrixWidget.h

@@ -25,6 +25,7 @@
 #include "ctkVTKAbstractMatrixWidget.h"
 #include "ctkVisualizationVTKWidgetsExport.h"
 
+/// \ingroup Visualization_VTK_Widgets
 class CTK_VISUALIZATION_VTK_WIDGETS_EXPORT ctkVTKMatrixWidget
   : public ctkVTKAbstractMatrixWidget
 {

Libs/Visualization/VTK/Widgets/ctkVTKRenderView.h

@@ -29,6 +29,7 @@ class ctkVTKRenderViewPrivate;
 class vtkCamera;
 class vtkRenderer;
 
+/// \ingroup Visualization_VTK_Widgets
 class CTK_VISUALIZATION_VTK_WIDGETS_EXPORT ctkVTKRenderView : public ctkVTKAbstractView
 {
   Q_OBJECT

Libs/Visualization/VTK/Widgets/ctkVTKRenderView_p.h

@@ -43,6 +43,7 @@
 class vtkRenderWindowInteractor;
 
 //-----------------------------------------------------------------------------
+/// \ingroup Visualization_VTK_Widgets
 class ctkVTKRenderViewPrivate : public ctkVTKAbstractViewPrivate
 {
   Q_OBJECT

Libs/Visualization/VTK/Widgets/ctkVTKScalarBarWidget.h

@@ -32,6 +32,7 @@
 class ctkVTKScalarBarWidgetPrivate;
 class vtkScalarBarWidget;
 
+/// \ingroup Visualization_VTK_Widgets
 class CTK_VISUALIZATION_VTK_WIDGETS_EXPORT ctkVTKScalarBarWidget : public QWidget
 {
   Q_OBJECT;

Libs/Visualization/VTK/Widgets/ctkVTKScalarsToColorsUtils.h

@@ -29,7 +29,7 @@ class vtkScalarsToColors;
 
 namespace ctk {
 ///
-/// \ingroup vtkWidgets
+/// \ingroup Visualization_VTK_Widgets
 /// Convert a vtkScalarsToColors into a QImage
 /// If size is empty, it will use the large icon size of the application style
 QImage CTK_VISUALIZATION_VTK_WIDGETS_EXPORT scalarsToColorsImage(vtkScalarsToColors* scalarsToColors, const QSize& size = QSize());

Libs/Visualization/VTK/Widgets/ctkVTKScalarsToColorsView.h

@@ -35,6 +35,7 @@ class vtkControlPointsItem;
 class vtkLookupTable;
 class vtkPiecewiseFunction;
 
+/// \ingroup Visualization_VTK_Widgets
 class CTK_VISUALIZATION_VTK_WIDGETS_EXPORT ctkVTKScalarsToColorsView
   : public ctkVTKChartView
 {

Libs/Visualization/VTK/Widgets/ctkVTKScalarsToColorsWidget.h

@@ -34,6 +34,7 @@ class ctkVTKScalarsToColorsWidgetPrivate;
 class vtkControlPointsItem;
 class vtkPlot;
 
+/// \ingroup Visualization_VTK_Widgets
 class CTK_VISUALIZATION_VTK_WIDGETS_EXPORT ctkVTKScalarsToColorsWidget : public QWidget
 {
   Q_OBJECT

Libs/Visualization/VTK/Widgets/ctkVTKSliceView.h

@@ -30,6 +30,7 @@ class vtkCamera;
 class vtkImageData;
 class vtkRenderer;
 
+/// \ingroup Visualization_VTK_Widgets
 /// Specific implementation for a 2D view that supports lightbox display.
 /// \note There is no support for gradient background yet.
 class CTK_VISUALIZATION_VTK_WIDGETS_EXPORT ctkVTKSliceView : public ctkVTKAbstractView

Libs/Visualization/VTK/Widgets/ctkVTKSliceView_p.h

@@ -40,6 +40,7 @@
 class vtkRenderWindowInteractor;
 
 //-----------------------------------------------------------------------------
+/// \ingroup Visualization_VTK_Widgets
 class ctkVTKSliceViewPrivate : public ctkVTKAbstractViewPrivate
 {
   Q_OBJECT

Libs/Visualization/VTK/Widgets/ctkVTKSurfaceMaterialPropertyWidget.h

@@ -29,6 +29,7 @@
 class ctkVTKSurfaceMaterialPropertyWidgetPrivate;
 class vtkProperty;
 
+/// \ingroup Visualization_VTK_Widgets
 class CTK_VISUALIZATION_VTK_WIDGETS_EXPORT ctkVTKSurfaceMaterialPropertyWidget
   : public ctkMaterialPropertyWidget
 {

Libs/Visualization/VTK/Widgets/ctkVTKTextPropertyWidget.h

@@ -32,6 +32,7 @@
 class ctkVTKTextPropertyWidgetPrivate;
 class vtkTextProperty;
 
+/// \ingroup Visualization_VTK_Widgets
 class CTK_VISUALIZATION_VTK_WIDGETS_EXPORT ctkVTKTextPropertyWidget : public QWidget
 {
   Q_OBJECT;

Libs/Visualization/VTK/Widgets/ctkVTKThresholdWidget.h

@@ -32,6 +32,7 @@ class ctkVTKThresholdWidgetPrivate;
 // VTK includes
 class vtkPiecewiseFunction;
 
+/// \ingroup Visualization_VTK_Widgets
 class CTK_VISUALIZATION_VTK_WIDGETS_EXPORT ctkVTKThresholdWidget
   : public QWidget
 {

Libs/Visualization/VTK/Widgets/ctkVTKThumbnailView.h

@@ -28,6 +28,7 @@
 
 class ctkVTKThumbnailViewPrivate;
 
+/// \ingroup Visualization_VTK_Widgets
 class CTK_VISUALIZATION_VTK_WIDGETS_EXPORT ctkVTKThumbnailView : public ctkVTKRenderView
 {
   Q_OBJECT

Libs/Visualization/VTK/Widgets/ctkVTKVolumePropertyWidget.h

@@ -32,6 +32,7 @@ class ctkVTKVolumePropertyWidgetPrivate;
 // VTK includes
 class vtkVolumeProperty;
 
+/// \ingroup Visualization_VTK_Widgets
 class CTK_VISUALIZATION_VTK_WIDGETS_EXPORT ctkVTKVolumePropertyWidget
   : public QWidget
 {

Libs/Visualization/VTK/Widgets/ctkVTKWidgetsUtils.h

@@ -35,14 +35,14 @@ class vtkImageData;
 namespace ctk {
 
 ///
-/// \ingroup VTKWidgets
+/// \ingroup Visualization_VTK_Widgets
 /// Grab the contents of a QWidget and all its children.
 /// Handle correctly the case of QVTKWidget.
 /// \sa ctk::grabWidget QWidget::grabWidget
 QImage CTK_VISUALIZATION_VTK_WIDGETS_EXPORT grabVTKWidget(QWidget* widget, QRect rectangle = QRect());
 
 ///
-/// \ingroup VTKWidgets
+/// \ingroup Visualization_VTK_Widgets
 /// Convert a vtkImageData into a QImage
 QImage CTK_VISUALIZATION_VTK_WIDGETS_EXPORT vtkImageDataToQImage(vtkImageData* imageData);
 

Libs/Visualization/XIP/ctkXIPAdaptor.h

@@ -27,6 +27,8 @@
 #include "ctkVisualizationXIPExport.h"
 
 class ctkXIPAdaptorPrivate;
+
+/// \ingroup Visualization_XIP
 class CTK_VISUALIZATION_XIP_EXPORT ctkXIPAdaptor : public QObject
 {
   Q_OBJECT

Libs/Widgets/Documentation/CTKWidgets.dox

@@ -0,0 +1,7 @@
+/**
+
+\defgroup Widgets
+\ingroup Libs
+\ingroup Project_Widgets
+
+*/

Libs/Widgets/ctkActionsWidget.h

@@ -37,6 +37,7 @@ class QStandardItemModel;
 class QStandardItem;
 class QTreeView;
 
+/// \ingroup Widgets
 /// ctkActionsWidget presents a list of QAction to the user. The QAction's are
 /// displayed in a multi column tree view. The columns contain the QAction's
 /// text, shortcut, context and tooltip in that order.
@@ -105,6 +106,7 @@ private:
   friend class ctkSortFilterActionsProxyModel;
 };
 
+/// \ingroup Widgets
 /// ctkSortFilterActionsProxyModel is a utility class that is needed by
 /// ctkActionsWidget. It's a specialization of a QSortFilterProxyModel and
 /// control what action is visible to the tree view.
@@ -130,6 +132,7 @@ private:
   Q_DISABLE_COPY(ctkSortFilterActionsProxyModel);
 };
 
+/// \ingroup Widgets
 /// ctkRichTextItemDelegate is a utility class that is needed by
 /// ctkActionsWidget. It control how QAction tree items are displayed when the
 /// text is written in HTML.

Libs/Widgets/ctkAddRemoveComboBox.h

@@ -34,6 +34,7 @@
 class QComboBox;
 class ctkAddRemoveComboBoxPrivate;
 
+/// \ingroup Widgets
 ///
 /// QComboBox with tool buttons to add/remove entries to the menu list
 class CTK_WIDGETS_EXPORT ctkAddRemoveComboBox : public QWidget

Libs/Widgets/ctkAxesWidget.h

@@ -30,6 +30,7 @@
 
 class ctkAxesWidgetPrivate;
 
+/// \ingroup Widgets
 class CTK_WIDGETS_EXPORT ctkAxesWidget : public QWidget
 {
   Q_OBJECT

Libs/Widgets/ctkBasePopupWidget.h

@@ -31,6 +31,7 @@
 
 class ctkBasePopupWidgetPrivate;
 
+/// \ingroup Widgets
 /// Description:
 class CTK_WIDGETS_EXPORT ctkBasePopupWidget : public QFrame
 {

Libs/Widgets/ctkBasePopupWidget_p.h

@@ -29,6 +29,7 @@ class QLabel;
 #include "ctkBasePopupWidget.h"
 
 // -------------------------------------------------------------------------
+/// \ingroup Widgets
 class CTK_WIDGETS_EXPORT ctkBasePopupWidgetPrivate
   : public QObject
 {

Libs/Widgets/ctkButtonGroup.h

@@ -31,6 +31,7 @@
 
 class ctkButtonGroupPrivate;
 
+/// \ingroup Widgets
 ///
 /// ctkButtonGroup is a QButtonGroup with a different behavior when exclusive.
 /// An exclusive ctkButtonGroup switches off the previously checked button when

Libs/Widgets/ctkCheckBox.h

@@ -29,6 +29,7 @@
 
 class ctkCheckBoxPrivate;
 
+/// \ingroup Widgets
 /// ctkCheckBox is an advanced QCheckBox that gives more control
 /// over its look and feel.
 /// We can change the indicator check box by a new QIcon, with two mode On/Off.

Libs/Widgets/ctkCheckBoxPixmaps.h

@@ -63,6 +63,7 @@ class QPixmap;
 class QWidget;
 class ctkCheckBoxPixmapsPrivate;
 
+/// \ingroup Widgets
 ///
 /// ctkCheckBoxPixmaps is a helper class that can used to create pixmaps for
 /// checkboxs in various states. This is useful for showing checkboxes in qt-views.

Libs/Widgets/ctkCheckableComboBox.h

@@ -30,6 +30,7 @@
 class ctkCheckableModelHelper;
 class ctkCheckableComboBoxPrivate;
 
+/// \ingroup Widgets
 /// Description
 /// ctkCheckableComboBox is a QComboBox that allow its items to be checkable
 class CTK_WIDGETS_EXPORT ctkCheckableComboBox : public QComboBox

Libs/Widgets/ctkCheckableHeaderView.h

@@ -61,6 +61,7 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 class ctkCheckableHeaderViewPrivate;
 class ctkCheckableModelHelper;
 
+/// \ingroup Widgets
 ///
 /// ctkCheckableHeaderView is a QHeaderView that can display a checkbox 
 /// for any header section.

Libs/Widgets/ctkCheckablePushButton.h

@@ -31,6 +31,7 @@
 
 class ctkCheckablePushButtonPrivate;
 
+/// \ingroup Widgets
 /// Description
 /// ctkCheckablePushButton is a QPushButton with a checkbox. By default
 /// the checkbox is connected to the checkable property of the push button.

Libs/Widgets/ctkCollapsibleButton.h

@@ -32,6 +32,7 @@
 class ctkCollapsibleButtonPrivate;
 class QStyleOptionButton;
 
+/// \ingroup Widgets
 /// A collapsible button that shows/hides its children depending on its
 /// checked/collapsed property.
 /// Warning: <old behavior> As ctkCollapsibleButton forces the Visiblity of its children to

Libs/Widgets/ctkCollapsibleGroupBox.h

@@ -28,6 +28,7 @@
 #include "ctkWidgetsExport.h"
 class ctkCollapsibleGroupBoxPrivate;
 
+/// \ingroup Widgets
 /// A QGroupBox with an arrow indicator that shows/hides the groupbox contents
 /// when clicked. It responds to the slot QGroupBox::setChecked(bool) or
 /// ctkCollapsibleGroupBox::setCollapsed(bool)

Libs/Widgets/ctkColorDialog.h

@@ -29,6 +29,7 @@
 
 class ctkColorDialogPrivate;
 
+/// \ingroup Widgets
 /// Customizable QColorDialog.
 /// Extra widgets can be added to the left of the dialog into a QStackedWidget
 class CTK_WIDGETS_EXPORT ctkColorDialog : public QColorDialog