瀏覽代碼

Fixed Doxygen warnings.

Sascha Zelzer 12 年之前
父節點
當前提交
c4cd80e8d2

+ 1 - 1
Libs/Core/ctkAbstractLibraryFactory.h

@@ -50,7 +50,7 @@ public:
   /// 
   /// \brief Resolve symbols
   /// \note The function will return False if it fails to resolve one
-  /// of the required symbols set using ::setSymbols
+  /// of the required symbols set using setSymbols(const QStringList&)
   bool resolve();
   
   /// 

+ 1 - 1
Libs/Core/ctkAbstractQObjectFactory.h

@@ -44,7 +44,7 @@ public:
   
   /// \brief Register an object in the factory
   /// The parameter \a key passed by reference will be updated with the
-  /// associated object name obtained using ::objectNameToKey()
+  /// associated object name obtained using objectNameToKey(const QString&)
   template<typename ClassType>
   bool registerQObject(QString& key);
 

+ 1 - 1
Libs/Core/ctkBackTrace.h

@@ -73,7 +73,7 @@ public:
   /**
    * @brief Get a textual representation for a given stack frame.
    * @param frameNumber The stack frame number.
-   * @return A string describing the stack frame with number <code>frameNumber<code>
+   * @return A string describing the stack frame with number <code>frameNumber</code>
    *         or a null QString if there is no corresponding stack frame.
    */
   QString stackFrame(unsigned frameNumber) const;

+ 2 - 2
Libs/PluginFramework/ctkPlugin.h

@@ -478,7 +478,7 @@ public:
    * <li>If this plugin's state was originally <code>ACTIVE</code>, the
    * updated plugin is started as described in the <code>ctkPlugin::start()</code>
    * method. If <code>ctkPlugin::start()</code> throws an exception, a Framework
-   * event of type {@link ctkPluginFrameworkEvent#ERROR} is fired containing the
+   * event of type {@link ctkPluginFrameworkEvent#PLUGIN_ERROR} is fired containing the
    * exception.
    * </ol>
    *
@@ -500,7 +500,7 @@ public:
    * <li>Original plugin is still used; no update occurred.
    * </ul>
    *
-   * @param input The <code>QUrl</code> from which to read the new
+   * @param updateLocation The <code>QUrl</code> from which to read the new
    *        plugin or <code>null</code> to indicate the Framework must create
    *        the URL from this plugin's
    *        {@link ctkPluginConstants#PLUGIN_UPDATELOCATION Plugin-UpdateLocation}

+ 1 - 1
Libs/PluginFramework/ctkPluginContext.h

@@ -646,7 +646,7 @@ public:
   bool connectFrameworkListener(const QObject* receiver, const char* slot, Qt::ConnectionType type = Qt::QueuedConnection);
 
   /**
-   * Disconnects the specified <code>slot</slot> from the context
+   * Disconnects the specified <code>slot</code> from the context
    * plugin.
    *
    * <p>

+ 6 - 6
Libs/PluginFramework/ctkPluginFramework.h

@@ -92,18 +92,18 @@ public:
    *         following <code>ctkPluginFrameworkEvent</code> types may be returned by
    *         this method.
    *         <ul>
-   *         <li>{@link ctkPluginFrameworkEvent#STOPPED STOPPED} - This Framework has
+   *         <li>{@link ctkPluginFrameworkEvent#FRAMEWORK_STOPPED STOPPED} - This Framework has
    *         been stopped. </li>
    *
-   *         <li>{@link ctkPluginFrameworkEvent#STOPPED_UPDATE STOPPED_UPDATE} - This
+   *         <li>{@link ctkPluginFrameworkEvent#FRAMEWORK_STOPPED_UPDATE STOPPED_UPDATE} - This
    *         Framework has been updated which has shutdown and will now
    *         restart.</li>
    *
-   *         <li>{@link ctkPluginFrameworkEvent#ERROR ERROR} - The Framework
+   *         <li>{@link ctkPluginFrameworkEvent#PLUGIN_ERROR ERROR} - The Framework
    *         encountered an error while shutting down or an error has occurred
    *         which forced the framework to shutdown. </li>
    *
-   *         <li> {@link ctkPluginFrameworkEvent#WAIT_TIMEDOUT WAIT_TIMEDOUT} - This
+   *         <li> {@link ctkPluginFrameworkEvent#FRAMEWORK_WAIT_TIMEDOUT WAIT_TIMEDOUT} - This
    *         method has timed out and returned before this Framework has
    *         stopped.</li>
    *         </ul>
@@ -148,13 +148,13 @@ public:
    * of this Framework is moved to start level zero (0), as described in the
    * <i>Start Level Service Specification</i>. Any exceptions that occur
    * during plugin stopping must be wrapped in a {@link ctkPluginException} and
-   * then published as a framework event of type {@link ctkPluginFrameworkEvent#ERROR}</li>
+   * then published as a framework event of type {@link ctkPluginFrameworkEvent#PLUGIN_ERROR}</li>
    * <li>Unregister all services registered by this Framework.</li>
    * <li>Event handling is disabled.</li>
    * <li>This Framework's state is set to {@link #RESOLVED}.</li>
    * <li>All resources held by this Framework are released. This includes
    * threads, loaded libraries, open files, etc.</li>
-   * <li>Notify all threads that are waiting at {@link #waitForStop(long)
+   * <li>Notify all threads that are waiting at {@link #waitForStop(unsigned long)
    * waitForStop} that the stop operation has completed.</li>
    * </ol>
    * <p>

+ 7 - 7
Libs/PluginFramework/ctkPluginFrameworkEvent.h

@@ -177,13 +177,13 @@ public:
    * <p>
    * The type values are:
    * <ul>
-   * <li>{@link #STARTED}
-   * <li>{@link #ERROR}
-   * <li>{@link #WARNING}
-   * <li>{@link #INFO}
-   * <li>{@link #STOPPED}
-   * <li>{@link #STOPPED_UPDATE}
-   * <li>{@link #WAIT_TIMEDOUT}
+   * <li>{@link #FRAMEWORK_STARTED}
+   * <li>{@link #PLUGIN_ERROR}
+   * <li>{@link #PLUGIN_WARNING}
+   * <li>{@link #PLUGIN_INFO}
+   * <li>{@link #FRAMEWORK_STOPPED}
+   * <li>{@link #FRAMEWORK_STOPPED_UPDATE}
+   * <li>{@link #FRAMEWORK_WAIT_TIMEDOUT}
    * </ul>
    *
    * @return The type of state change.

+ 2 - 2
Libs/PluginFramework/ctkPluginFrameworkLauncher.h

@@ -50,7 +50,7 @@ public:
    *
    * <p>
    * If the framework has already been initialized by a call
-   * to #install(const QString&) or #start, the
+   * to #install or #start, the
    * new properties do not have any effect until the framework
    * is restarted.
    *
@@ -157,7 +157,7 @@ public:
   /**
    * Add a path to the list of search paths for plugins.
    *
-   * When calling #install(const QString&), #start, or
+   * When calling #install(const QString&, ctkPluginContext*), #start, or
    * #getPluginPath(const QString&), the plugin is searched in the
    * paths given as arguments to this method. The least recently added
    * path is searched first.

+ 1 - 1
Libs/Widgets/Documentation/CTKWidgets.dox

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

+ 2 - 2
Libs/Widgets/ctkCheckablePushButton.h

@@ -64,13 +64,13 @@ public:
 
   ///
   /// Set the alignment of the text on the button,
-  /// Qt::Left|Qt::VCenter by default.
+  /// Qt::AlignLeft|Qt::AlignVCenter by default.
   void setButtonTextAlignment(Qt::Alignment textAlignment);
   Qt::Alignment buttonTextAlignment()const;
 
   ///
   /// Set the alignment of the indicator (arrow) on the button,
-  /// Qt::Left|Qt::VCenter by default.
+  /// Qt::AlignLeft|Qt::AlignVCenter by default.
   void setIndicatorAlignment(Qt::Alignment indicatorAlignment);
   Qt::Alignment indicatorAlignment()const;
 

+ 4 - 4
Libs/Widgets/ctkCollapsibleButton.h

@@ -35,11 +35,11 @@ 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
+/// Warning: &lt;old behavior&gt; As ctkCollapsibleButton forces the Visiblity of its children to
 /// true when it get expanded, any child Visibility property is lost. All the widgets
 /// will then be visible. To avoid this behavior, use an intermediate widget that
 /// contains all the children (they would become grandchildren and their Visibility property
-/// will remain relative to their parent, ctkCollapsibleButton's unique child widget.</old behavior>
+/// will remain relative to their parent, ctkCollapsibleButton's unique child widget.&lt;/old behavior&gt;
 /// Note: The user QAbstractButton::icon is not visible (it's placeholder is used to display the
 /// collapsible state
 class CTK_WIDGETS_EXPORT ctkCollapsibleButton : public QAbstractButton
@@ -100,13 +100,13 @@ public:
 
   ///
   /// Set the alignment of the text on the button,
-  /// Qt::Left|Qt::VCenter by default.
+  /// Qt::AlignLeft|Qt::AlignVCenter by default.
   void setButtonTextAlignment(Qt::Alignment textAlignment);
   Qt::Alignment buttonTextAlignment()const;
 
   ///
   /// Set the alignment of the indicator (arrow) on the button,
-  /// Qt::Left|Qt::VCenter by default.
+  /// Qt::AlignLeft|Qt::AlignVCenter by default.
   void setIndicatorAlignment(Qt::Alignment indicatorAlignment);
   Qt::Alignment indicatorAlignment()const;