Changeset 116 in pacpusframework for trunk/include/Pacpus/kernel/ComponentFactoryBase.h

Timestamp:

06/25/13 13:44:25 (11 years ago)

Author:

Marek Kurdej

Message:

Added: PacpusException - base class for all exceptions. DbiteExceptions inherits from it.
Added: PacpusLibConfig.h - dllimport/dllexport clauses separated from pacpus.h.
Update: comments.

File:

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

trunk/include/Pacpus/kernel/ComponentFactoryBase.h

@@ -16 +16 @@
 #define DEF_PACPUS_COMPONENTFACTORYBASE_H
 
-#include <Pacpus/kernel/pacpus.h>
+#include <Pacpus/kernel/PacpusLibConfig.h>
 
 class QString;
@@ -25 +25 @@
 class ComponentBase;
 
-/** ComponentFactoryBase
- * @brief Provide an abstract class to the template ComponentFactory.
- */
+/// ComponentFactoryBase
+/// @brief Provide an abstract class to the template ComponentFactory.
 class PACPUSLIB_API ComponentFactoryBase
 {
     friend class ComponentManager;
+
 public:
-    /** Ctor of ComponentFactoryBase. */
+    /// Ctor of ComponentFactoryBase.
     ComponentFactoryBase();
-    /** Dtor of ComponentFactoryBase. */
+    /// Dtor of ComponentFactoryBase.
     virtual ~ComponentFactoryBase();
 
 protected:
-    /** Create a new component having @em name as component name.
-     * @param name Name of the instantiated component.
-     * @return Pointer on the newly created component, you become the owner of its lifetime.
-     */
+    /// Creates a new component having @em name as component name.
+    /// Caller becomes the owner of its lifetime
+    ///
+    /// @param name Name of the instantiated component.
+    /// @returns Pointer on the newly created component.
     virtual ComponentBase * instantiateComponent(const QString& name) = 0;
     
-    /** Register a new factory.
-     * @param addr Address of the factory.
-     * @param type Name of the type created by the factory.
-     */
+    /// Registers a new factory.
+    ///
+    /// @param addr Address of the factory.
+    /// @param type Name of the type created by the factory.
     void addFactory(ComponentFactoryBase* addr, const QString& type);
     
-    /** Add a new component.
-     * @param name Name of the new component.
-     */
+    /// Adds a new component.
+    ///
+    /// @param name Name of the new component.
     void addComponent(const QString& name);