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


Ignore:
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:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/include/Pacpus/kernel/ComponentBase.h

    r42 r61  
    9090     */
    9191    virtual COMPONENT_CONFIGURATION configureComponent(XmlComponentConfig config) = 0;
    92 
    93     // The XML node that is got in the configureComponent method
     92   
     93protected:
     94    /// The XML node that is got in the configureComponent method
    9495    XmlComponentConfig param;
    9596
    96     // the name of the component. It is this one in the XML config file
     97    /// the name of the component. It is this one in the XML config file
    9798    QString componentName;
    9899
    99     // is the component is recording data?
     100    /// is the component is recording data?
    100101    bool recording;
    101102
    102     // provided for compatibility with old DBITE framework
     103    /// provided for compatibility with old DBITE framework
    103104    bool THREAD_ALIVE;
    104105
    105     // is the component active?
     106    /// is the component active?
    106107    bool mIsActive;
    107108
    108     // a pointer to the manager of components
     109    /// a pointer to the manager of components
    109110    ComponentManager * mgr;
    110111
    111112private:
    112     // called by the ComponentManager to start the component
     113    /// called by the ComponentManager to start the component
    113114    int startComponent();
    114115
    115     // called by the ComponentManager to stop the component
     116    /// called by the ComponentManager to stop the component
    116117    int stopComponent();
    117118
    118     // store the state of the component
     119    /// store the state of the component
    119120    COMPONENT_STATE componentState_;
    120121
    121     // is the component configured (ie configureComponent method was called)
     122    /// is the component configured (ie configureComponent method was called)
    122123    COMPONENT_CONFIGURATION configuration_;
    123124};
  • trunk/include/Pacpus/kernel/DbiteFile.h

    r59 r61  
    2323namespace pacpus {
    2424
     25/// @todo Documentation
    2526struct FILELIB_API VariableDataSizeTag {};
    2627FILELIB_API extern VariableDataSizeTag VariableDataSize;
    2728
     29/// @todo Documentation
    2830struct FILELIB_API ReadModeTag {};
    2931FILELIB_API extern ReadModeTag ReadMode;
    3032
     33/// @todo Documentation
    3134struct FILELIB_API WriteModeTag {};
    3235FILELIB_API extern WriteModeTag WriteMode;
    3336
     37/// @todo Documentation
    3438struct FILELIB_API DiagnoseModeTag {};
    3539FILELIB_API extern DiagnoseModeTag DiagnoseMode;
    3640
     41/// @todo Documentation
    3742class FILELIB_API DbiteFile
    3843{
  • trunk/include/Pacpus/kernel/hdfile_header_t.h

    r32 r61  
    1919
    2020#pragma pack(push,4)
     21/// @todo Documentation
    2122struct hdfile_header_t
    2223{
     24    /// @todo Documentation
    2325    typedef  int8_t SignatureT;
     26    /// @todo Documentation
    2427    typedef int32_t DataTypeT;
     28    /// @todo Documentation
    2529    typedef int32_t VersionT;
     30    /// @todo Documentation
    2631    typedef int32_t DataSizeT;
     32    /// @todo Documentation
    2733    typedef int32_t DataOffsetT;
    28     // FIXME: file size should be 64-bit long to support large (>2GB) files
     34    /// @todo Documentation
     35    /// @todo FIXME: file size should be 64-bit long to support large (>2GB) files
    2936    typedef int32_t FileSizeT;
     37    /// @todo Documentation
    3038    typedef int32_t RecordCountT;
    3139
     40    /// @todo Documentation
    3241    static const DataSizeT kVariableRecordSize = -1;
    3342
     43    /// @todo Documentation
    3444    SignatureT      Signature[HEADER_SIGNATURE_LENGTH];
    35     DataTypeT       Type;           /* IMAGE, CAN, UNKNOWN, etc. */
     45    /// Record data type
     46    /// Should default to @link FILE_DBT_UNKNOWN
     47    /// @see DbiteFileTypes.h for more
     48    DataTypeT       Type;
     49    /// File format version
    3650    VersionT        VersionNumber;
    37     DataOffsetT     DataOffset;     /* starting of the data */
    38     DataSizeT       DataSize;       /* number of byte for data */
    39     FileSizeT       FileSize;       /* current size of the file */
    40     road_time_t     TimeMin, TimeMax;
    41     RecordCountT    NbRecords;      /* number of records */
     51    /// Offset indicating the start of the data [bytes]
     52    DataOffsetT     DataOffset;
     53    /// Current size of the data, without header [bytes]
     54    DataSizeT       DataSize;
     55    /// Current size of the file [bytes]
     56    FileSizeT       FileSize;
     57    /// @todo Documentation
     58    road_time_t     TimeMin;
     59    /// @todo Documentation
     60    road_time_t     TimeMax;
     61    /// Number of records already in the file
     62    RecordCountT    NbRecords;
    4263};
    4364#pragma pack(pop)
Note: See TracChangeset for help on using the changeset viewer.