Просмотр исходного кода

Fixed broken doxygen generation for Plugin Framework

In some of the header files in the plugin framework, the two macros

  Q_DECLARE_PRIVATE(ctkPlugin)
  Q_DISABLE_COPY(ctkPlugin)

appeared at the beginning of the class declaration. This is valid c++,
but the doxygen generator intrepret this as a private statement and
thus all subsequent public method declarations are interpreted as private,
thus hiding them from the user documentation.

We have no idea why doxygen does this.

Investigation was done in cooperation with @jcfr.

Fix: Moved the offending macros to the end of the class declaration.
Christian Askeland лет назад: 10
Родитель
Сommit
dc3b3fe132

+ 4 - 3
Libs/PluginFramework/ctkPlugin.h

@@ -82,9 +82,6 @@ class ctkPluginPrivate;
  */
 class CTK_PLUGINFW_EXPORT ctkPlugin {
 
-  Q_DECLARE_PRIVATE(ctkPlugin)
-  Q_DISABLE_COPY(ctkPlugin)
-
 public:
 
   enum State {
@@ -812,6 +809,10 @@ protected:
   ctkPlugin();
   void init(ctkPluginPrivate* dd);
   void init(const QWeakPointer<ctkPlugin>& self, ctkPluginFrameworkContext* fw, QSharedPointer<ctkPluginArchive> ba);
+
+private:
+  Q_DECLARE_PRIVATE(ctkPlugin)
+  Q_DISABLE_COPY(ctkPlugin)
 };
 
 /**

+ 3 - 1
Libs/PluginFramework/ctkPluginContext.h

@@ -97,7 +97,6 @@ class ctkPluginContextPrivate;
  */
 class CTK_PLUGINFW_EXPORT ctkPluginContext
 {
-  Q_DECLARE_PRIVATE(ctkPluginContext)
 
 public:
 
@@ -733,6 +732,9 @@ protected:
   ctkPluginContext(ctkPluginPrivate* plugin);
 
   ctkPluginContextPrivate * const d_ptr;
+
+private:
+  Q_DECLARE_PRIVATE(ctkPluginContext)
 };
 
 

+ 3 - 3
Libs/PluginFramework/ctkPluginFramework.h

@@ -45,9 +45,6 @@ class ctkPluginFrameworkPrivate;
 class CTK_PLUGINFW_EXPORT ctkPluginFramework : public ctkPlugin
 {
 
-  Q_DECLARE_PRIVATE(ctkPluginFramework)
-  Q_DISABLE_COPY(ctkPluginFramework)
-
 public:
 
   /**
@@ -199,6 +196,9 @@ protected:
 
   ctkPluginFramework();
 
+private:
+  Q_DECLARE_PRIVATE(ctkPluginFramework)
+  Q_DISABLE_COPY(ctkPluginFramework)
 };
 
 

+ 2 - 2
Libs/PluginFramework/ctkServiceReference.h

@@ -67,8 +67,6 @@ class ctkServiceEvent;
  */
 class CTK_PLUGINFW_EXPORT ctkServiceReference {
 
-  Q_DECLARE_PRIVATE(ctkServiceReference)
-
 public:
 
   /**
@@ -213,6 +211,8 @@ protected:
 
   ctkServiceReferencePrivate * d_ptr;
 
+private:
+  Q_DECLARE_PRIVATE(ctkServiceReference)
 };
 
 /**

+ 2 - 2
Libs/PluginFramework/ctkServiceRegistration.h

@@ -49,8 +49,6 @@ class ctkServiceRegistrationPrivate;
  */
 class CTK_PLUGINFW_EXPORT ctkServiceRegistration {
 
-  Q_DECLARE_PRIVATE(ctkServiceRegistration)
-
 public:
 
   /**
@@ -167,6 +165,8 @@ protected:
 
   ctkServiceRegistrationPrivate* d_ptr;
 
+private:
+  Q_DECLARE_PRIVATE(ctkServiceRegistration)
 };
 
 /**