Changeset 61 in pacpusframework for trunk/include/Pacpus/kernel/ComponentBase.h

Timestamp:

Jan 9, 2013, 1:40:39 PM (12 years ago)

Author:

Marek Kurdej

Message:

Added: some documentation and doc todo comments.

File:

• trunk/include/Pacpus/kernel/ComponentBase.h (modified) (1 diff)

trunk/include/Pacpus/kernel/ComponentBase.h

@@ -90 +90 @@
      */
     virtual COMPONENT_CONFIGURATION configureComponent(XmlComponentConfig config) = 0;
-
-    // The XML node that is got in the configureComponent method
+    
+protected:
+    /// The XML node that is got in the configureComponent method
     XmlComponentConfig param;
 
-    // the name of the component. It is this one in the XML config file
+    /// the name of the component. It is this one in the XML config file
     QString componentName;
 
-    // is the component is recording data?
+    /// is the component is recording data?
     bool recording;
 
-    // provided for compatibility with old DBITE framework
+    /// provided for compatibility with old DBITE framework
     bool THREAD_ALIVE;
 
-    // is the component active?
+    /// is the component active?
     bool mIsActive;
 
-    // a pointer to the manager of components
+    /// a pointer to the manager of components
     ComponentManager * mgr;
 
 private:
-    // called by the ComponentManager to start the component
+    /// called by the ComponentManager to start the component
     int startComponent();
 
-    // called by the ComponentManager to stop the component
+    /// called by the ComponentManager to stop the component
     int stopComponent();
 
-    // store the state of the component
+    /// store the state of the component
     COMPONENT_STATE componentState_;
 
-    // is the component configured (ie configureComponent method was called)
+    /// is the component configured (ie configureComponent method was called)
     COMPONENT_CONFIGURATION configuration_;
 };