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


Ignore:
Timestamp:
01/09/13 13:40:39 (11 years ago)
Author:
Marek Kurdej
Message:

Added: some documentation and doc todo comments.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • 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.