Changeset 13 in pacpusframework for trunk/include/Pacpus

Timestamp:

Jan 8, 2013, 1:15:23 AM (12 years ago)

Author:

sgosseli

Message:

Add some documentation.

File:

• trunk/include/Pacpus/kernel/ComponentManager.h (modified) (5 diffs)

trunk/include/Pacpus/kernel/ComponentManager.h

@@ -1 @@
-/*********************************************************************
-// created:     2006/02/07 - 11:20
-// filename:    componentManager.h
-//
-// author:      Gerald Dherbomez
-//
-// purpose:     This class records the components and manages them
-//              This class is a singleton
-//              Use the static ComponentManager::create() function
-//              to get a pointer on this object.
-*********************************************************************/
+/**
+ *
+ * Distributed under the UTC Heudiascy Pacpus License, Version 1.0.
+ * Copyright (c) UTC Heudiasyc 2010 - 2013. All rights reserved.
+ *
+ * See the LICENSE file for more information or a copy at:
+ *   http://www.hds.utc.fr/~kurdejma/LICENSE_1_0.txt
+ *
+ */
 
 #ifndef COMPONENTMANAGER_H
@@ -15 +13 @@
 
 #include <cstddef>
+
 #include <QMap>
 #include <QList>
@@ -27 +26 @@
 
 class ComponentBase;
-//class ComponentFactoryBase;
 
 typedef QMap<QString, ComponentBase *> ComponentMap;
 typedef QMap<QString, ComponentFactoryBase *> FactoryMap;
 
+/** ComponentManager
+ * @brief Singleton recording the components and managing them.
+ */
 class ComponentManager
 {
@@ -41 +42 @@
     PACPUS_DEPRECATED_MSG( static PACPUSLIB_API ComponentManager * create(), "use 'getInstance()'" );
 
-    /// @returns a pointer to the ComponentManager object
-    static PACPUSLIB_API ComponentManager * getInstance();
+    /** Get the singleton of the ComponentManager class.
+     * @return Pointer to the ComponentManager singleton.
+     */
+    static PACPUSLIB_API ComponentManager* getInstance();
 
-    /// Destroys the ComponentManager object
+    /** Destroy the ComponentManager singleton.
+     * After this call, every pointer to the ComponentManager becomes invalid.
+     */
     static PACPUSLIB_API void destroy();
 
@@ -57 +62 @@
     };
 
-    /// Call this function to load the components included in the XML config file
-    /// Usually, this is done in the main() !
+    /** Load the components included in the XML config file.
+     * @param file Name of the XML file.
+     * @return Number of components loaded by the manager.
+     */
     std::size_t PACPUSLIB_API loadComponents(QString file);
 
-    /// Start all the components
+    /** Start all the components
+     * @return True if all the component has been started, otherwise false.
+     */
     int PACPUSLIB_API start();
 
-    /// Start only the component passed in parameter
+    /** Start only the component passed in parameter.
+     * @param component Component to start.
+     * @return True if the component exists and has been started, otherwise false.
+     */
     int PACPUSLIB_API start(QString component);
 
-    /// Stop all the components
+    /** Stop all the components
+     * @return True if all the component has been stopped, otherwise false.
+     */
     int PACPUSLIB_API stop();
 
-    /// Stop only the component passed in parameter
+    /** Stop only the component passed in parameter.
+     * @param component Component to stop.
+     * @return True if the component has been stopped, otherwise false.
+     */
     int PACPUSLIB_API stop(QString component);
 
-    /// Get a pointer to the component referred by 'name' parameter
+    /** Get a pointer to the component referred by @em name.
+     * @param name Name of the component.
+     * @return Pointer to the component if it exists, otherwise @em NULL.
+     */
     PACPUSLIB_API ComponentBase* getComponent(QString name);
 
-    /// Get the list of all the names of the component known by the manager
+    /** Get the list of all the names of the component known by the manager.
+     * @return List of all the component's name.
+     */
     PACPUSLIB_API QStringList getAllComponentsName();
 
-    /// Load a new plugin from the file filename (it may be a .so/.dll file)
+    /** Load a new plugin from the file filename (it may be a .so/.dll file)
+     * @param filename Name of the shared object or the dll.
+     * @return True if the plugin has been loaded, otherwise false.
+     */
     bool PACPUSLIB_API loadPlugin(QString filename);