Bladeren bron

Added doxygen groupings.

Sascha Zelzer 13 jaren geleden
bovenliggende
commit
17a44cbbba

+ 2 - 0
Libs/CommandLineModules/Core/ctkCmdLineModuleDescription.h

@@ -35,6 +35,8 @@ class ctkCmdLineModuleParameterGroup;
 class ctkCmdLineModuleParameter;
 
 /**
+ * \ingroup CommandLineModulesCore
+ *
  * Description of the parameters of a command line module.
  *
  * The parameters can be used for automated GUI generation or execution

+ 3 - 0
Libs/CommandLineModules/Core/ctkCmdLineModuleInstance.h

@@ -30,6 +30,9 @@
 class ctkCmdLineModuleReference;
 class ctkCmdLineModuleInstancePrivate;
 
+/**
+ * \ingroup CommandLineModulesCore
+ */
 class CTK_CMDLINEMODULECORE_EXPORT ctkCmdLineModuleInstance : public QObject
 {
   Q_OBJECT

+ 3 - 0
Libs/CommandLineModules/Core/ctkCmdLineModuleInstanceFactory.h

@@ -27,6 +27,9 @@
 class ctkCmdLineModuleInstance;
 class ctkCmdLineModuleReference;
 
+/**
+ * \ingroup CommandLineModulesCore
+ */
 struct CTK_CMDLINEMODULECORE_EXPORT ctkCmdLineModuleInstanceFactory
 {
   virtual ~ctkCmdLineModuleInstanceFactory();

+ 3 - 1
Libs/CommandLineModules/Core/ctkCmdLineModuleManager.h

@@ -33,7 +33,9 @@ class ctkCmdLineModuleInstance;
 class ctkCmdLineModuleReference;
 class ctkCmdLineModuleManagerPrivate;
 
-/// The methods in this class are for playing around... no API design yet
+/**
+ * \ingroup CommandLineModulesCore
+ */
 class CTK_CMDLINEMODULECORE_EXPORT ctkCmdLineModuleManager
 {
 

+ 3 - 0
Libs/CommandLineModules/Core/ctkCmdLineModuleObjectHierarchyReader.h

@@ -32,6 +32,9 @@ class QObject;
 
 class ctkCmdLineModuleObjectHierarchyReaderPrivate;
 
+/**
+ *  \ingroup CommandLineModulesCore
+ */
 class CTK_CMDLINEMODULECORE_EXPORT ctkCmdLineModuleObjectHierarchyReader
 {
 

+ 2 - 0
Libs/CommandLineModules/Core/ctkCmdLineModuleParameter.h

@@ -31,6 +31,8 @@ class QStringList;
 class ctkCmdLineModuleParameterPrivate;
 
 /** 
+ *  \ingroup CommandLineModulesCore
+ *
  *  \brief Single parameter to a module, like a threshold of a filter.
  *
  * ctkCmdLineModuleParameter describes a single parameters to a

+ 5 - 3
Libs/CommandLineModules/Core/ctkCmdLineModuleParameterGroup.h

@@ -32,9 +32,11 @@ class ctkCmdLineModuleParameter;
 class ctkCmdLineModuleParameterGroupPrivate;
 
 /** 
-*  \brief Group of parameters
-*
-*/
+ *  \ingroup CommandLineModulesCore
+ *
+ *  \brief Group of parameters
+ *
+ */
 class CTK_CMDLINEMODULECORE_EXPORT ctkCmdLineModuleParameterGroup
 {
 

+ 3 - 0
Libs/CommandLineModules/Core/ctkCmdLineModuleReference.h

@@ -29,6 +29,9 @@
 class ctkCmdLineModuleDescription;
 class ctkCmdLineModuleReferencePrivate;
 
+/**
+ * \ingroup CommandLineModulesCore
+ */
 class CTK_CMDLINEMODULECORE_EXPORT ctkCmdLineModuleReference
 {
 public:

+ 3 - 0
Libs/CommandLineModules/Core/ctkCmdLineModuleXmlException.h

@@ -26,6 +26,9 @@
 
 #include "ctkCommandLineModulesCoreExport.h"
 
+/**
+ * \ingroup CommandLineModulesCore
+ */
 CTK_DECLARE_EXCEPTION(CTK_CMDLINEMODULECORE_EXPORT, ctkCmdLineModuleXmlException, ctkException)
 
 #endif // CTKCMDLINEMODULEXMLEXCEPTION_H

+ 3 - 0
Libs/CommandLineModules/Core/ctkCmdLineModuleXmlValidator.h

@@ -28,6 +28,9 @@
 
 class QIODevice;
 
+/**
+ * \ingroup CommandLineModulesCore
+ */
 class CTK_CMDLINEMODULECORE_EXPORT ctkCmdLineModuleXmlValidator
 {
 

+ 3 - 0
Libs/CommandLineModules/Core/ctkCmdLineModuleXslTransform.h

@@ -29,6 +29,9 @@
 
 class QIODevice;
 
+/**
+ * \ingroup CommandLineModulesCore
+ */
 class CTK_CMDLINEMODULECORE_EXPORT ctkCmdLineModuleXslTransform
     : public ctkCmdLineModuleXmlValidator
 {

+ 18 - 0
Libs/CommandLineModules/Documentation/CTKCommandLineModules.dox

@@ -0,0 +1,18 @@
+/**
+
+\defgroup CommandLineModules Command Line Modules
+\ingroup Projects
+
+CTK provides an API for interfacing with command line modules through a
+self-describing XML description of the supported command line arguments.
+
+\defgroup CommandLineModulesCore Command Line Module Support
+\ingroup Libs
+\ingroup CommandLineModules
+
+\defgroup CommandLineModulesQtGui Command Line Module QtGui Support
+\ingroup Libs
+\ingroup CommandLineModules
+
+*/
+