Changeset 61 in pacpusframework for trunk/include/Pacpus/kernel

Timestamp:

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

Author:

Marek Kurdej

Message:

Added: some documentation and doc todo comments.

Location:

trunk/include/Pacpus/kernel

Files:

• ComponentBase.h (modified) (1 diff)
• DbiteFile.h (modified) (1 diff)
• hdfile_header_t.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_;
 };

trunk/include/Pacpus/kernel/DbiteFile.h

@@ -23 +23 @@
 namespace pacpus {
 
+/// @todo Documentation
 struct FILELIB_API VariableDataSizeTag {};
 FILELIB_API extern VariableDataSizeTag VariableDataSize;
 
+/// @todo Documentation
 struct FILELIB_API ReadModeTag {};
 FILELIB_API extern ReadModeTag ReadMode;
 
+/// @todo Documentation
 struct FILELIB_API WriteModeTag {};
 FILELIB_API extern WriteModeTag WriteMode;
 
+/// @todo Documentation
 struct FILELIB_API DiagnoseModeTag {};
 FILELIB_API extern DiagnoseModeTag DiagnoseMode;
 
+/// @todo Documentation
 class FILELIB_API DbiteFile
 {

trunk/include/Pacpus/kernel/hdfile_header_t.h

@@ -19 +19 @@
 
 #pragma pack(push,4)
+/// @todo Documentation
 struct hdfile_header_t
 {
+    /// @todo Documentation
     typedef  int8_t SignatureT;
+    /// @todo Documentation
     typedef int32_t DataTypeT;
+    /// @todo Documentation
     typedef int32_t VersionT;
+    /// @todo Documentation
     typedef int32_t DataSizeT;
+    /// @todo Documentation
     typedef int32_t DataOffsetT;
-    // FIXME: file size should be 64-bit long to support large (>2GB) files
+    /// @todo Documentation
+    /// @todo FIXME: file size should be 64-bit long to support large (>2GB) files
     typedef int32_t FileSizeT;
+    /// @todo Documentation
     typedef int32_t RecordCountT;
 
+    /// @todo Documentation
     static const DataSizeT kVariableRecordSize = -1;
 
+    /// @todo Documentation
     SignatureT      Signature[HEADER_SIGNATURE_LENGTH];
-    DataTypeT       Type;           /* IMAGE, CAN, UNKNOWN, etc. */
+    /// Record data type
+    /// Should default to @link FILE_DBT_UNKNOWN
+    /// @see DbiteFileTypes.h for more
+    DataTypeT       Type;
+    /// File format version
     VersionT        VersionNumber;
-    DataOffsetT     DataOffset;     /* starting of the data */
-    DataSizeT       DataSize;       /* number of byte for data */
-    FileSizeT       FileSize;       /* current size of the file */
-    road_time_t     TimeMin, TimeMax;
-    RecordCountT    NbRecords;      /* number of records */
+    /// Offset indicating the start of the data [bytes]
+    DataOffsetT     DataOffset;
+    /// Current size of the data, without header [bytes]
+    DataSizeT       DataSize;
+    /// Current size of the file [bytes]
+    FileSizeT       FileSize;
+    /// @todo Documentation
+    road_time_t     TimeMin;
+    /// @todo Documentation
+    road_time_t     TimeMax;
+    /// Number of records already in the file
+    RecordCountT    NbRecords;
 };
 #pragma pack(pop)