Changeset 71 in pacpusframework for trunk/include/Pacpus/kernel/ComponentManager.h

Timestamp:

01/10/13 15:07:34 (11 years ago)

Author:

Marek Kurdej

Message:

Added: more documentation.
doc/doxyfile.in: turned on BUILTIN_STL_SUPPORT in Doxygen.
Added: LICENSE-header.txt to be included in all source files.

File:

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

trunk/include/Pacpus/kernel/ComponentManager.h

@@ -31 +31 @@
 class ComponentBase;
 
+/// @todo Documentation
 typedef QMap<QString, ComponentBase *> ComponentMap;
+/// @todo Documentation
 typedef QMap<QString, ComponentFactoryBase *> FactoryMap;
 
-/** ComponentManager
- * @brief Singleton recording the components and managing them.
- */
+/// Singleton recording the components and managing them.
 class ComponentManager
 {
@@ -43 +43 @@
 public:
     /// @returns a pointer to the ComponentManager object
-    /// @deprecated use getInstance()
+    /// @deprecated Use getInstance()
     PACPUS_DEPRECATED_MSG( static PACPUSLIB_API ComponentManager * create(), "use 'getInstance()'" );
 
-    /** Get the singleton of the ComponentManager class.
-     * @return Pointer to the ComponentManager singleton.
-     */
+    /// Returns an instance of the singleton ComponentManager class.
+    /// @returns Pointer to the ComponentManager singleton.
     static PACPUSLIB_API ComponentManager* getInstance();
 
-    /** Destroy the ComponentManager singleton.
-     * After this call, every pointer to the ComponentManager becomes invalid.
-     */
+    /// Destroys the ComponentManager singleton.
+    ///
+    /// After this call, every pointer to the ComponentManager becomes invalid.
     static PACPUSLIB_API void destroy();