Fixed doxygen warnings (in user doc).

Documentation/CMakeLists.txt

@@ -44,6 +44,8 @@ IF( DOXYGEN_FOUND )
     #
     SET( CTK_USER_DOCUMENTATION "YES" )
     SET( CTK_ADDITIONAL_EXCLUDE_PATTERN "" )
+    SET( CTK_ADDITIONAL_FILE_PATTERN "*.c \  *.cc \  *.cxx \  *.cpp \  *.c++ \  *.hxx \  *.hpp \  *.h++ \  *.txx \  *.C \  *.CC \  *.C++ \  *.moc" )
+
 
     CONFIGURE_FILE( Doxyfile.txt.in
       ${CMAKE_CURRENT_BINARY_DIR}/DevDoxyfile.txt

Documentation/Doxyfile.txt.in

@@ -626,11 +626,7 @@ INPUT_ENCODING         = UTF-8
 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
 # *.f90 *.f *.for *.vhd *.vhdl
 
-FILE_PATTERNS          = *.c \
-                         *.cc \
-                         *.cxx \
-                         *.cpp \
-                         *.c++ \
+FILE_PATTERNS          = @CTK_ADDITIONAL_FILE_PATTERN@ \
                          *.d \
                          *.java \
                          *.ii \
@@ -640,10 +636,6 @@ FILE_PATTERNS          = *.c \
                          *.inl \
                          *.h \
                          *.hh \
-                         *.hxx \
-                         *.hpp \
-                         *.h++ \
-                         *.txx \
                          *.idl \
                          *.odl \
                          *.cs \
@@ -658,9 +650,6 @@ FILE_PATTERNS          = *.c \
                          *.f \
                          *.vhd \
                          *.vhdl \
-                         *.C \
-                         *.CC \
-                         *.C++ \
                          *.II \
                          *.I++ \
                          *.H \
@@ -676,12 +665,9 @@ FILE_PATTERNS          = *.c \
                          *.F \
                          *.VHD \
                          *.VHDL \
-                         *.C \
-                         *.H \
                          *.tlh \
                          *.diff \
                          *.patch \
-                         *.moc \
                          *.xpm \
                          *.dox
 

Libs/Core/ctkAbstractFactory.h

@@ -67,7 +67,7 @@ private:
 /// \ingroup Core
 /// \brief ctkAbstractFactory is the base class of all the factory where items need
 /// to be registered before being instantiated.
-/// \paragraph ctkAbstractFactory contains a collection of ctkAbstractFactoryItems that
+/// <p> ctkAbstractFactory contains a collection of ctkAbstractFactoryItems that
 /// are uniquely identifyed by a key. Subclasses of ctkAbstractFactory are
 /// responsible for populating the list of ctkAbstractFactoryItems.
 /// BaseClassType could be any type (most probably a QObject) 

Libs/Core/ctkCommandLineParser.h

@@ -98,6 +98,19 @@ public:
    * Constructs a parser instance.
    *
    * If QSettings support is enabled by a call to <code>enableSettings()</code>
+   * a default constructed QSettings instance will be used when parsing
+   * the command line arguments. Make sure to call <code>QCoreApplication::setOrganizationName()</code>
+   * and <code>QCoreApplication::setApplicationName()</code> before using default
+   * constructed QSettings objects.
+   *
+   * @param newParent The QObject parent.
+   */
+  ctkCommandLineParser(QObject* newParent = 0);
+
+  /**
+   * Constructs a parser instance.
+   *
+   * If QSettings support is enabled by a call to <code>enableSettings()</code>
    * the provided QSettings instance will be used. If the QSettings instance is
    * zero, a default constructed QSettings instance will be used when parsing
    * the command line arguments. Using a default constructed instance is usually
@@ -105,8 +118,10 @@ public:
    * and <code>QCoreApplication::setApplicationName()</code>.
    *
    * @param settings A QSettings instance which should be used.
+   * @param newParent The QObject parent.
+   *
+   *
    */
-  ctkCommandLineParser(QObject* newParent = 0);
   ctkCommandLineParser(QSettings* settings, QObject* newParent = 0);
 
   ~ctkCommandLineParser();

Libs/Core/ctkSingleton.h

@@ -48,7 +48,7 @@ typedef NAME Self;
 //
 /// Should be added at the bottom of the header file, after the class declaration
 //
-/// The instance (NAME##Initializer) will show up in any translation unit
+/// The instance (NAME##%Initializer) will show up in any translation unit
 /// that uses NAME.  It will make sure NAME is initialized before it is used.
 /// 
 #define CTK_SINGLETON_DECLARE_INITIALIZER(EXPORT_DIRECTIVE,NAME)   \
@@ -68,9 +68,9 @@ static NAME##Initialize NAME##Initializer;
 
 //-----------------------------------------------------------------------------
 //
-/// Implementation of NAME##Initialize class.
+/// Implementation of %NAME##%Initialize class.
 //
-/// Note: NAME##Initialize::Count and NAME::Instance Must NOT be initialized.
+/// Note: NAME##%Initialize::%Count and NAME::%Instance Must NOT be initialized.
 /// Default initialization to zero is necessary.
 //
 #define CTK_SINGLETON_DEFINE_INITIALIZER(NAME)      \

Libs/DICOM/Core/ctkDICOMDatabase.h

@@ -45,9 +45,12 @@ public:
   bool isInMemory() const;
 
   ///
-  /// open the SQLite database in @param file. If the file does not
+  /// open the SQLite database in @param databaseFile . If the file does not
   /// exist, a new database is created and initialized with the
   /// default schema
+  ///
+  /// @param databaseFile TODO
+  /// @param connectionName TODO
   virtual void openDatabase(const QString databaseFile, const QString& connectionName = "DICOM-DB" );
 
   ///

Libs/PluginFramework/Documentation/CTKPluginFramework.dox

@@ -15,6 +15,4 @@ The CTK Plugin Framework is an OSGi like modularization framework for building c
 \defgroup Metatype Metatype
 \ingroup PluginFramework
 
-\defgroup 
-
 */

Libs/PluginFramework/ctkLDAPSearchFilter.h

@@ -51,7 +51,7 @@ class ctkLDAPSearchFilterData;
  * \endverbatim
  *
  * \see "CTK Wiki for a description of the filter string syntax." TODO!
- * \threadsafe
+ * \remarks This class is thread safe.
  */
 class CTK_PLUGINFW_EXPORT ctkLDAPSearchFilter {
 

Libs/PluginFramework/ctkPlugin.h

@@ -77,7 +77,7 @@ class ctkPluginPrivate;
  * <code>%ctkPlugin</code> objects, and these objects are only valid within the
  * Framework that created them.
  *
- * @threadsafe
+ * @remarks This class is thread safe.
  */
 class CTK_PLUGINFW_EXPORT ctkPlugin {
 
@@ -135,7 +135,7 @@ public:
      *
      * <p>
      * A plugin is in the <code>STARTING</code> state when its
-     * {@link #start(const Options&) start} method is active. A plugin must be in this
+     * {@link #start(const StartOptions&) start} method is active. A plugin must be in this
      * state when the plugin's {@link ctkPluginActivator::start} method is called. If the
      * <code>ctkPluginActivator::start</code> method completes without exception,
      * then the plugin has successfully started and must move to the
@@ -153,7 +153,7 @@ public:
      *
      * <p>
      * A plugin is in the <code>STOPPING</code> state when its
-     * {@link #stop(const Option&) stop} method is active. A plugin must be in this state
+     * {@link #stop(const StopOptions&) stop} method is active. A plugin must be in this state
      * when the plugin's {@link ctkPluginActivator::stop} method is called. When the
      * <code>ctkPluginActivator::stop</code> method completes the plugin is
      * stopped and must move to the <code>RESOLVED</code> state.
@@ -413,8 +413,8 @@ public:
    * <ul>
    * <li>Plugin autostart setting is modified unless the
    * {@link #STOP_TRANSIENT} option was set.
-   * <li><code>getState()</code> not in &#x007B; <code>ACTIVE</code>,
-   * <code>STOPPING</code> &#x007D;.
+   * <li><code>getState()</code> not in &#123; <code>ACTIVE</code>,
+   * <code>STOPPING</code> &#125;.
    * <li><code>ctkPluginActivator::stop</code> has been called and did not throw
    * an exception.
    * </ul>
@@ -469,19 +469,19 @@ public:
    *
    * <b>Preconditions </b>
    * <ul>
-   * <li><code>getState()</code> not in &#x007B; <code>UNINSTALLED</code>
-   * &#x007D;.
+   * <li><code>getState()</code> not in &#123; <code>UNINSTALLED</code>
+   * &#125;.
    * </ul>
    * <b>Postconditions, no exceptions thrown </b>
    * <ul>
-   * <li><code>getState()</code> in &#x007B; <code>UNINSTALLED</code>
-   * &#x007D;.
+   * <li><code>getState()</code> in &#123; <code>UNINSTALLED</code>
+   * &#125;.
    * <li>This plugin has been uninstalled.
    * </ul>
    * <b>Postconditions, when an exception is thrown </b>
    * <ul>
-   * <li><code>getState()</code> not in &#x007B; <code>UNINSTALLED</code>
-   * &#x007D;.
+   * <li><code>getState()</code> not in &#123; <code>UNINSTALLED</code>
+   * &#125;.
    * <li>This plugin has not been uninstalled.
    * </ul>
    *
@@ -664,7 +664,7 @@ public:
   /**
    * Returns the version of this plugin as specified by its
    * <code>Plugin-Version</code> manifest header. If this plugin does not have a
-   * specified version then {@link Version#emptyVersion} is returned.
+   * specified version then {@link ctkVersion#emptyVersion} is returned.
    *
    * <p>
    * This method must continue to return this plugin's version while

Libs/PluginFramework/ctkPluginConstants.cpp

@@ -21,8 +21,8 @@
 
 #include "ctkPluginConstants.h"
 
-const QString	ctkPluginConstants::SYSTEM_PLUGIN_LOCATION = "System Plugin";
-const QString	ctkPluginConstants::SYSTEM_PLUGIN_SYMBOLICNAME = "system.plugin";
+const QString ctkPluginConstants::SYSTEM_PLUGIN_LOCATION = "System Plugin";
+const QString ctkPluginConstants::SYSTEM_PLUGIN_SYMBOLICNAME = "system.plugin";
 
 const QString ctkPluginConstants::FRAMEWORK_VERSION = "org.commontk.pluginfw.version";
 const QString ctkPluginConstants::FRAMEWORK_VENDOR = "org.commontk.pluginfw.vendor";
@@ -30,7 +30,7 @@ const QString ctkPluginConstants::FRAMEWORK_STORAGE = "org.commontk.pluginfw.sto
 const QString ctkPluginConstants::FRAMEWORK_STORAGE_CLEAN = "org.commontk.pluginfw.storage.clean";
 const QString ctkPluginConstants::FRAMEWORK_STORAGE_CLEAN_ONFIRSTINIT = "onFirstInit";
 
-const QString	ctkPluginConstants::PLUGIN_SYMBOLICNAME = "Plugin-SymbolicName";
+const QString ctkPluginConstants::PLUGIN_SYMBOLICNAME = "Plugin-SymbolicName";
 const QString ctkPluginConstants::PLUGIN_COPYRIGHT = "Plugin-Copyright";
 const QString ctkPluginConstants::PLUGIN_DESCRIPTION = "Plugin-Description";
 const QString ctkPluginConstants::PLUGIN_NAME = "Plugin-Name";
@@ -38,10 +38,11 @@ const QString ctkPluginConstants::PLUGIN_LOCALIZATION = "Plugin-Localization";
 const QString ctkPluginConstants::PLUGIN_LOCALIZATION_DEFAULT_BASENAME = "CTK-INF/l10n/plugin";
 const QString ctkPluginConstants::REQUIRE_PLUGIN = "Require-Plugin";
 const QString ctkPluginConstants::PLUGIN_VERSION_ATTRIBUTE = "plugin-version";
-const QString	ctkPluginConstants::PLUGIN_VERSION = "Plugin-Version";
-const QString	ctkPluginConstants::PLUGIN_ACTIVATIONPOLICY = "Plugin-ActivationPolicy";
+const QString ctkPluginConstants::PLUGIN_VERSION = "Plugin-Version";
+const QString ctkPluginConstants::PLUGIN_ACTIVATIONPOLICY = "Plugin-ActivationPolicy";
 
-const QString	ctkPluginConstants::ACTIVATION_EAGER = "eager";
+const QString ctkPluginConstants::ACTIVATION_EAGER = "eager";
+const QString ctkPluginConstants::ACTIVATION_LAZY = "lazy";
 
 const QString ctkPluginConstants::RESOLUTION_DIRECTIVE = "resolution";
 const QString ctkPluginConstants::RESOLUTION_MANDATORY = "mandatory";

Libs/PluginFramework/ctkPluginConstants.h

@@ -205,13 +205,8 @@ struct CTK_PLUGINFW_EXPORT ctkPluginConstants {
   static const QString PLUGIN_ACTIVATIONPOLICY; // = "Plugin-ActivationPolicy"
 
   /**
-   * Plugin activation policy declaring the plugin must be activated when the
-   * first object is instantiated from the plugin.
-   * <p>
-   * A plugin with the lazy (default) activation policy
-   * will wait in the ctkPlugin#STARTING state until the first
-   * class instantiation from the plugin occurs. The plugin will then be activated
-   * before the instance is returned to the requester.
+   * Plugin activation policy declaring the plugin must be activated immediately.
+   *
    * <p>
    * A plugin with the eager activation policy that is started with the
    * ctkPlugin#START_ACTIVATION_POLICY option will be activating immediately when
@@ -231,6 +226,24 @@ struct CTK_PLUGINFW_EXPORT ctkPluginConstants {
   static const QString ACTIVATION_EAGER; // = "eager"
 
   /**
+   * Plugin activation policy declaring the plugin must be activated when the
+   * first object is instantiated from the plugin.
+   * <p>
+   * A plugin with the lazy activation policy that is started with the
+   * {@link ctkPlugin#START_ACTIVATION_POLICY START_ACTIVATION_POLICY} option
+   * will wait in the ctkPlugin#STARTING state until the first
+   * class instantiation from the plugin occurs. The plugin will then be activated
+   * before the instance is returned to the requester.
+   * <p>
+   * The lazy activation policy is the default for every plugin.
+   *
+   * @see #PLUGIN_ACTIVATIONPOLICY
+   * @see ctkPlugin#start(int)
+   * @see ctkPlugin#START_ACTIVATION_POLICY
+   */
+  static const QString ACTIVATION_LAZY; // = "lazy"
+
+  /**
    * Manifest header directive identifying the resolution type in the
    * Require-Plugin manifest header. The default value is
    * {@link #RESOLUTION_MANDATORY mandatory}.
@@ -325,7 +338,7 @@ struct CTK_PLUGINFW_EXPORT ctkPluginConstants {
    *
    * <p>
    * By convention, every plugin has its own unique namespace, starting with
-   * the plugin's identifier (see {@link ctkPlugin#getPluginId}) and followed by
+   * the plugin's identifier (see ctkPlugin::getPluginId) and followed by
    * a dot (.). A plugin may use this as the prefix of the persistent
    * identifiers for the services it registers.
    */
@@ -343,7 +356,7 @@ struct CTK_PLUGINFW_EXPORT ctkPluginConstants {
    *
    * <p>
    * The service ranking is used by the Framework to determine the <i>natural
-   * order</i> of services, see {@link ctkServiceReference::operator<(const ctkServiceReference&)},
+   * order</i> of services, see ctkServiceReference::operator<(const ctkServiceReference&),
    * and the <i>default</i> service to be returned from a call to the
    * {@link ctkPluginContext::getServiceReference} method.
    *

Libs/PluginFramework/ctkPluginContext.h

@@ -93,7 +93,7 @@ class ctkPluginContextPrivate;
  * The Framework is the only entity that can create <code>ctkPluginContext</code>
  * objects and they are only valid within the Framework that created them.
  *
- * @threadsafe
+ * @remarks This class is thread safe.
  */
 class CTK_PLUGINFW_EXPORT ctkPluginContext
 {
@@ -180,7 +180,7 @@ public:
    * be ignored.
    * <li>The service is added to the Framework service registry and may now be
    * used by other plugins.
-   * <li>A service event of type {@link ServiceEvent#REGISTERED} is fired.
+   * <li>A service event of type {@link ctkServiceEvent#REGISTERED} is fired.
    * <li>A <code>ctkServiceRegistration</code> object for this registration is
    * returned.
    * </ol>
@@ -264,11 +264,11 @@ public:
    * <p>
    * The specified <code>filter</code> expression is used to select the
    * registered services whose service properties contain keys and values
-   * which satisfy the filter expression. See {@link Filter} for a description
+   * which satisfy the filter expression. See {@link ctkLDAPSearchFilter} for a description
    * of the filter syntax. If the specified <code>filter</code> is
    * empty, all registered services are considered to match the
    * filter. If the specified <code>filter</code> expression cannot be parsed,
-   * an {@link std::invalid_argument} will be thrown with a human readable
+   * an <code>std::invalid_argument</code> will be thrown with a human readable
    * message where the filter became unparsable.
    *
    * <p>
@@ -279,7 +279,7 @@ public:
    * empty, the service must have been registered with the
    * specified class name. The complete list of class names with which a
    * service was registered is available from the service's
-   * {@link PlugincConstants::OBJECTCLASS objectClass} property.
+   * {@link ctkPluginConstants::OBJECTCLASS objectClass} property.
    * <li>If the specified <code>filter</code> is not empty, the
    * filter expression must match the service.
    * </ul>
@@ -386,9 +386,9 @@ public:
    * <p>
    * A plugin's use of a service is tracked by the plugin's use count of that
    * service. Each time a service's service object is returned by
-   * {@link #getService(ctkServiceReference*)} the context plugin's use count for
+   * {@link #getService(const ctkServiceReference&)} the context plugin's use count for
    * that service is incremented by one. Each time the service is released by
-   * {@link #ungetService(ctkServiceReference*)} the context plugin's use count
+   * {@link #ungetService(const ctkServiceReference&)} the context plugin's use count
    * for that service is decremented by one.
    * <p>
    * When a plugin's use count for a service drops to zero, the plugin should
@@ -407,7 +407,7 @@ public:
    * <li>If the context plugin's use count for the service is currently one
    * and the service was registered with an object implementing the
    * <code>ctkServiceFactory</code> interface, the
-   * {@link ctkServiceFactory::getService(ctkPlugin*, ctkServiceRegistration*)} method is
+   * {@link ctkServiceFactory::getService} method is
    * called to create a service object for the context plugin. This service
    * object is cached by the Framework. While the context plugin's use count
    * for the service is greater than zero, subsequent calls to get the
@@ -459,7 +459,7 @@ public:
    *         <code>ctkServiceReference</code> was not created by the same
    *         framework instance as this <code>ctkPluginContext</code> or
    *         if it is invalid (default constructed).
-   * @see #getService(ctkServiceReference)
+   * @see #getService(const ctkServiceReference&)
    * @see #ungetService(const ctkServiceReference&)
    * @see ctkServiceFactory
    */
@@ -491,7 +491,7 @@ public:
    * <li>If the context plugin's use count for the service is currently zero
    * and the service was registered with a <code>ctkServiceFactory</code> object,
    * the
-   * {@link ctkServiceFactory#ungetService(ctkPlugin*, ctkServiceRegistration*, QObject*)}
+   * {@link ctkServiceFactory#ungetService}
    * method is called to release the service object for the context plugin.
    * <li><code>true</code> is returned.
    * </ol>
@@ -572,8 +572,8 @@ public:
    *
    * <b>Postconditions, no exceptions thrown </b>
    * <ul>
-   * <li><code>getState()</code> in &#x007B; <code>INSTALLED</code>,
-   * <code>RESOLVED</code> &#x007D;.
+   * <li><code>getState()</code> in &#123; <code>INSTALLED</code>,
+   * <code>RESOLVED</code> &#125;.
    * <li>Plugin has a unique ID.
    * </ul>
    * <b>Postconditions, when an exception is thrown </b>
@@ -592,7 +592,7 @@ public:
    *         installation failed.
    * @throws std::logic_error If this ctkPluginContext is no longer valid.
    */
-  QSharedPointer<ctkPlugin> installPlugin(const QUrl& location, QIODevice* in = 0);
+  QSharedPointer<ctkPlugin> installPlugin(const QUrl& location, QIODevice* input = 0);
 
   /**
    * Connects the specified <code>slot</code> to the context

Libs/PluginFramework/ctkPluginEvent.h

@@ -138,7 +138,7 @@ public:
     /**
      * The plugin will be lazily activated.
      * <p>
-     * The plugin has a \link ctkPluginConstant::ACTIVATION_LAZY lazy activation policy\endlink
+     * The plugin has a \link ctkPluginConstants::ACTIVATION_LAZY lazy activation policy\endlink
      * and is waiting to be activated. It is now in the
      * \link ctkPlugin::STARTING STARTING\endlink state and has a valid
      * <code>ctkPluginContext</code>. This

Libs/PluginFramework/ctkPluginFramework.h

@@ -41,7 +41,7 @@ class ctkPluginFrameworkPrivate;
  * of this class can be used to manage and control the created plugin framework
  * instance.
  *
- * @threadsafe
+ * @remarks This class is thread safe.
  */
 class CTK_PLUGINFW_EXPORT ctkPluginFramework : public ctkPlugin
 {

Libs/PluginFramework/ctkPluginFrameworkEvent.h

@@ -182,7 +182,6 @@ public:
    * <li>{@link #ERROR}
    * <li>{@link #WARNING}
    * <li>{@link #INFO}
-   * <li>{@link #STARTLEVEL_CHANGED}
    * <li>{@link #STOPPED}
    * <li>{@link #STOPPED_UPDATE}
    * <li>{@link #WAIT_TIMEDOUT}

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(const QString&), the
+   * to #install(const QString&) or #start, the
    * new properties do not have any effect until the framework
    * is restarted.
    *
@@ -131,7 +131,7 @@ public:
   /**
    * Add a path to the list of search paths for plugins.
    *
-   * When calling #install(const QString&), #start(const QString&), or
+   * When calling #install(const QString&), #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.

Libs/PluginFramework/ctkPluginTracker.h

@@ -59,7 +59,7 @@ template<class T> class ctkPluginTrackerPrivate;
  * \tparam T The type of the tracked object. The type must be an assignable
  *         datatype, provide a boolean conversion function, and provide
  *         a constructor and an assignment operator which can handle 0 as an argument.
- * \threadsafe
+ * \remarks This class is thread safe.
  */
 template<class T = QSharedPointer<ctkPlugin> >
 class ctkPluginTracker : protected ctkPluginTrackerCustomizer<T>

Libs/PluginFramework/ctkPluginTrackerCustomizer.h

@@ -57,7 +57,7 @@ class ctkPlugin;
  * thread-safe.
  *
  * \tparam T The type of the tracked object.
- * \threadsafe
+ * \remarks This class is thread safe.
  */
 template<class T>
 struct ctkPluginTrackerCustomizer {

Libs/PluginFramework/ctkServiceEvent.h

@@ -132,10 +132,10 @@ public:
    * Creates a new service event object.
    *
    * @param type The event type.
-   * @param reference A <code>ServiceReference</code> object to the service
+   * @param reference A <code>ctkServiceReference</code> object to the service
    *        that had a lifecycle change.
    */
-  ctkServiceEvent(Type type, const ctkServiceReference& plugin);
+  ctkServiceEvent(Type type, const ctkServiceReference& reference);
 
   ctkServiceEvent(const ctkServiceEvent& other);
 

Libs/PluginFramework/ctkServiceFactory.h

@@ -54,7 +54,7 @@
  * may concurrently call a <code>ctkServiceFactory</code>.
  *
  * @see ctkPluginContext#getService
- * @threadsafe
+ * @remarks This class is thread safe.
  */
 class ctkServiceFactory
 {

Libs/PluginFramework/ctkServiceReference.h

@@ -63,7 +63,7 @@ class ctkServiceEvent;
  * @see ctkPluginContext::getServiceReference
  * @see ctkPluginContext::getServiceReferences
  * @see ctkPluginContext::getService
- * @threadsafe
+ * @remarks This class is thread safe.
  */
 class CTK_PLUGINFW_EXPORT ctkServiceReference {
 

Libs/PluginFramework/ctkServiceRegistration.h

@@ -45,7 +45,7 @@ class ctkServiceRegistrationPrivate;
  * properties of the service or to unregister the service.
  *
  * @see ctkPluginContext#registerService()
- * @threadsafe
+ * @remarks This class is thread safe.
  */
 class CTK_PLUGINFW_EXPORT ctkServiceRegistration {
 
@@ -98,7 +98,7 @@ public:
    * The following steps are required to modify service properties:
    * <ol>
    * <li>The service's properties are replaced with the provided properties.
-   * <li>A service event of type {@link ServiceEvent#MODIFIED} is fired.
+   * <li>A service event of type {@link ctkServiceEvent#MODIFIED} is fired.
    * </ol>
    *
    * @param properties The properties for this service. See {@link ctkPluginConstants}
@@ -125,7 +125,7 @@ public:
    * <ol>
    * <li>The service is removed from the Framework service registry so that
    * it can no longer be obtained.
-   * <li>A service event of type {@link ServiceEvent#UNREGISTERING} is fired
+   * <li>A service event of type {@link ctkServiceEvent#UNREGISTERING} is fired
    * so that plugins using this service can release their use of the service.
    * Once delivery of the service event is complete, the
    * <code>ctkServiceReference</code> objects for the service may no longer be

Libs/PluginFramework/ctkServiceTracker.h

@@ -68,7 +68,7 @@ class ctkPluginContext;
  * \tparam T The type of the tracked object. The type must be an assignable
  *         datatype, provide a boolean conversion function, and provide
  *         a constructor and an assignment operator which can handle 0 as an argument.
- * \threadsafe
+ * \remarks This class is thread safe.
  */
 template<class S = QObject*, class T = S>
 class ctkServiceTracker : protected ctkServiceTrackerCustomizer<T>
@@ -362,7 +362,7 @@ protected:
    * This method can be overridden in a subclass to customize the service
    * object to be tracked for the service being added. In that case, take care
    * not to rely on the default implementation of
-   * \link removedService(const ctkServiceReference&, QObject*) removedService\endlink
+   * \link removedService(const ctkServiceReference&, T service) removedService\endlink
    * to unget the service.
    *
    * @param reference The reference to the service being added to this

Libs/PluginFramework/ctkServiceTrackerCustomizer.h

@@ -55,7 +55,7 @@
  * thread-safe.
  *
  * \tparam T The type of the tracked object.
- * \threadsafe
+ * \remarks This class is thread safe.
  */
 template<class T = QObject*>
 struct ctkServiceTrackerCustomizer {

Libs/PluginFramework/ctkVersion.h

@@ -45,8 +45,6 @@
  *
  * <p>
  * <code>ctkVersion</code> objects are immutable.
- *
- * @Immutable
  */
 class CTK_PLUGINFW_EXPORT ctkVersion {
 

Libs/PluginFramework/service/cm/ctkConfiguration.h

@@ -68,9 +68,6 @@
  * The same <code>ctkConfiguration</code> object is used for configuring both a
  * Managed Service Factory and a Managed Service. When it is important to
  * differentiate between these two the term "factory configuration" is used.
- *
- * @noimplement
- * @version
  */
 struct CTK_PLUGINFW_EXPORT ctkConfiguration
 {

Libs/PluginFramework/service/cm/ctkConfigurationAdmin.h

@@ -32,7 +32,7 @@
  * <p>
  * The main purpose of this interface is to store plugin configuration data
  * persistently. This information is represented in <code>ctkConfiguration</code>
- * objects. The actual configuration data is a <code>Dictionary</code> of
+ * objects. The actual configuration data is a <code>ctkDictionary</code> of
  * properties inside a <code>ctkConfiguration</code> object.
  *
  * <p>
@@ -63,7 +63,7 @@
  * checks its persistent storage for a configuration object whose
  * <code>service.pid</code> property matches the PID service property (
  * <code>service.pid</code>) of the Managed Service. If found, it calls
- * {@link ctkManagedService#updated} method with the new properties. The
+ * ctkManagedService#updated method with the new properties. The
  * implementation of a Configuration Admin service must run these call-backs
  * asynchronously to allow proper synchronization.
  *
@@ -73,7 +73,7 @@
  * <code>service.factoryPid</code> property matches the PID service property of
  * the Managed Service Factory. For each such <code>ctkConfiguration</code>
  * objects, it calls the <code>ctkManagedServiceFactory#updated</code> method
- * asynchronously with the new properties. The calls to the <code>updated</code>
+ * asynchronously with the new properties. The calls to the <code>%updated</code>
  * method of a <code>ctkManagedServiceFactory</code> must be executed sequentially
  * and not overlap in time.
  *
@@ -151,7 +151,7 @@ struct CTK_PLUGINFW_EXPORT ctkConfigurationAdmin
    *
    * The properties of the new <code>ctkConfiguration</code> object are
    * <code>null</code> until the first time that its
-   * {@link ctkConfiguration#update(Dictionary)} method is called.
+   * {@link ctkConfiguration#update(const ctkDictionary&)} method is called.
    *
    * <p>
    * It is not required that the <code>factoryPid</code> maps to a

Libs/PluginFramework/service/event/ctkEvent.h

@@ -83,7 +83,7 @@ public:
    * An event is considered to be <b>equal to</b> another event if the topic
    * is equal and the properties are equal.
    *
-   * @param object The <code>ctkEvent</code> object to be compared.
+   * @param other The <code>ctkEvent</code> object to be compared.
    * @return <code>true</code> if <code>other</code> is equal to
    *         this object; <code>false</code> otherwise.
    */

Libs/PluginFramework/service/event/ctkEventAdmin.h

@@ -66,7 +66,6 @@ struct ctkEventAdmin
    *
    * @param publisher The owner of the signal.
    * @param signal The signal in normalized form.
-   * @param signal_topic The topic string for the events this signal is emitting.
    * @param type Qt::QueuedConnection for asynchronous delivery and
    *        Qt::DirectConnection for synchronous delivery.
    */
@@ -80,7 +79,7 @@ struct ctkEventAdmin
    *
    * Slots should be registered with a property ctkEventConstants::EVENT_TOPIC.
    * The value being a QString or QStringList object that describes which
-   * topics the slot is interested in. A wildcard (’*’ \u002A) may be used as
+   * topics the slot is interested in. A wildcard (’*’ \\u002A) may be used as
    * the last token of a topic name, for example com/action&#47*. This matches any
    * topic that shares the same first tokens. For example, com/action&#47* matches
    * com/action/listen. Slots which have not been specified with the EVENT_TOPIC
@@ -129,7 +128,7 @@ struct ctkEventAdmin
    * @return <code>true</code> if a slot was registered under this subscriptionId and its
    *         properties where changed, <code>false</code> otherwise.
    */
-  virtual bool updateProperties(qlonglong subsriptionId, const ctkDictionary& properties) = 0;
+  virtual bool updateProperties(qlonglong subscriptionId, const ctkDictionary& properties) = 0;
 
 };
 

Libs/PluginFramework/service/event/ctkEventHandler.h

@@ -66,8 +66,7 @@
  *
  * @see ctkEvent
  *
- * @ThreadSafe
- * @version $Id: 2b8202d10e77b774897c74714115059f46abc7e1 $
+ * @remarks This class is thread safe.
  */
 struct ctkEventHandler
 {

Libs/PluginFramework/service/log/ctkLogEntry.h

@@ -42,7 +42,7 @@
  * <code>ctkLogReaderService#getLog()</code> method or by registering a
  * <code>ctkLogListener</code> object.
  *
- * @ThreadSafe
+ * @remarks This class is thread safe.
  * @see ctkLogReaderService#getLog()
  * @see ctkLogListener
  */

Libs/PluginFramework/service/log/ctkLogListener.h

@@ -39,7 +39,7 @@
  * Qt slots can also be used to be notified about new <code>ctkLogEntry</code>
  * objects. See <code>ctkLogReaderService#connectLogListener()</code>.
  *
- * @ThreadSafe
+ * @remarks This class is thread safe.
  * @see ctkLogReaderService
  * @see ctkLogEntry
  * @see ctkLogReaderService#connectLogListener()

Libs/PluginFramework/service/log/ctkLogReaderService.h

@@ -44,8 +44,9 @@
  * <li>To retrieve past <code>ctkLogEntry</code> objects, the <code>getLog()</code>
  * method can be called which will return a QList of all
  * <code>ctkLogEntry</code> objects in the log.
+ * </ul>
  *
- * @ThreadSafe
+ * @remarks This class is thread safe.
  * @see ctkLogEntry
  * @see ctkLogListener
  * @see ctkLogListener#logged(ctkLogEntryPtr)

Libs/PluginFramework/service/log/ctkLogService.h

@@ -49,7 +49,7 @@
  * <li>#LOG_DEBUG
  * </ol>
  *
- * \ThreadSafe
+ * \remarks This class is thread safe.
  */
 struct CTK_PLUGINFW_EXPORT ctkLogService
 {
@@ -104,6 +104,10 @@ struct CTK_PLUGINFW_EXPORT ctkLogService
    *        user defined way.
    * \param message Human readable string describing the condition.
    * \param exception The exception that reflects the condition or <code>null</code>.
+   * \param file The current file name.
+   * \param function The current function name.
+   * \param line The current line number.
+   *
    * \see #LOG_ERROR
    * \see #LOG_WARNING
    * \see #LOG_INFO
@@ -128,6 +132,9 @@ struct CTK_PLUGINFW_EXPORT ctkLogService
    * \param message Human readable string describing the condition.
    * \param exception The exception that reflects the condition or
    *        <code>null</code>.
+   * \param file The current file name.
+   * \param function The current function name.
+   * \param line The current line number.
    *
    * \see #LOG_ERROR
    * \see #LOG_WARNING

Libs/PluginFramework/service/metatype/ctkMetaTypeProvider.h

@@ -36,7 +36,7 @@
  * registered as a service, it must be registered with a
  * {@link #METATYPE_FACTORY_PID} or {@link #METATYPE_PID} service property (or
  * both). Any PID mentioned in either of these factories must be a valid argument
- * to the {@link #getObjectClassDefinition(const QString, const QString)} method.
+ * to the {@link #getObjectClassDefinition(const QString&, const QLocale&)} method.
  */
 struct CTK_PLUGINFW_EXPORT ctkMetaTypeProvider
 {

Libs/Widgets/ctkColorPickerButton.h

@@ -31,7 +31,7 @@ class ctkColorPickerButtonPrivate;
 
 ///
 /// ctkColorPickerButton is a QPushButton that refers to a color. The color
-/// and the name of the color (i.e. #FFFFFF) are displayed on the button.
+/// and the name of the color (i.e. #FFFFFF) are displayed on the button.
 /// When clicked, a color dialog pops up to select a new color
 /// for the QPushButton.
 class CTK_WIDGETS_EXPORT ctkColorPickerButton : public QPushButton

Libs/Widgets/ctkSettings.h

@@ -72,27 +72,27 @@ class CTK_WIDGETS_EXPORT ctkSettings : public QSettings
   Q_OBJECT
 
 public:
-  /// See \QSettings::QSettings(const QString& ,const QString& , QObject* )
+  /// \see QSettings::QSettings(const QString& ,const QString& , QObject* )
   ctkSettings(
     const QString& organization,
     const QString& application,
     QObject* parent = 0);
-  /// See \QSettings::QSettings(QSettings::Scope ,const QString& ,const QString& , QObject* )
+  /// \see QSettings::QSettings(QSettings::Scope ,const QString& ,const QString& , QObject* )
   ctkSettings(
     QSettings::Scope scope,
     const QString& organization,
     const QString& application = QString(),
     QObject* parent = 0);
-  /// See \QSettings::QSettings(QSettings::Format ,QSettings::Scope ,const QString& ,const QString& , QObject* )
+  /// \see QSettings::QSettings(QSettings::Format ,QSettings::Scope ,const QString& ,const QString& , QObject* )
   ctkSettings(
     QSettings::Format format,
     QSettings::Scope scope,
     const QString& organization,
     const QString& application = QString(),
     QObject* parent = 0);
-  /// See \QSettings::QSettings(const QString& , QSettings::Format , QObject* )
+  /// \see QSettings::QSettings(const QString& , QSettings::Format , QObject* )
   ctkSettings(const QString& fileName, QSettings::Format format, QObject* parent = 0);
-  /// See \QSettings::QSettings(QObject*)
+  /// \see QSettings::QSettings(QObject*)
   ctkSettings(QObject* parent = 0);
 
   /// Saves the position, size and layout of the QMainWindow