Skip to content

Commit

Permalink
Fix brief description comments after members (#1920)
Browse files Browse the repository at this point in the history
Current description comments after members start with '//!', resulting in broken documentation showing the descriptions on the wrong members. Change that to '//!<' according to doxygen documentation to have descriptions correctly associated with the respective members.
  • Loading branch information
elektrokokke authored and dirk-thomas committed May 21, 2020
1 parent fad5134 commit ce59bdd
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions tools/rosbag_storage/include/rosbag/structures.h
Original file line number Diff line number Diff line change
Expand Up @@ -59,25 +59,25 @@ struct ROSBAG_STORAGE_DECL ConnectionInfo

struct ChunkInfo
{
ros::Time start_time; //! earliest timestamp of a message in the chunk
ros::Time end_time; //! latest timestamp of a message in the chunk
uint64_t pos; //! absolute byte offset of chunk record in bag file
ros::Time start_time; //!< earliest timestamp of a message in the chunk
ros::Time end_time; //!< latest timestamp of a message in the chunk
uint64_t pos; //!< absolute byte offset of chunk record in bag file

std::map<uint32_t, uint32_t> connection_counts; //! number of messages in each connection stored in the chunk
std::map<uint32_t, uint32_t> connection_counts; //!< number of messages in each connection stored in the chunk
};

struct ROSBAG_STORAGE_DECL ChunkHeader
{
std::string compression; //! chunk compression type, e.g. "none" or "bz2" (see constants.h)
uint32_t compressed_size; //! compressed size of the chunk in bytes
uint32_t uncompressed_size; //! uncompressed size of the chunk in bytes
std::string compression; //!< chunk compression type, e.g. "none" or "bz2" (see constants.h)
uint32_t compressed_size; //!< compressed size of the chunk in bytes
uint32_t uncompressed_size; //!< uncompressed size of the chunk in bytes
};

struct ROSBAG_STORAGE_DECL IndexEntry
{
ros::Time time; //! timestamp of the message
uint64_t chunk_pos; //! absolute byte offset of the chunk record containing the message
uint32_t offset; //! relative byte offset of the message record (either definition or data) in the chunk
ros::Time time; //!< timestamp of the message
uint64_t chunk_pos; //!< absolute byte offset of the chunk record containing the message
uint32_t offset; //!< relative byte offset of the message record (either definition or data) in the chunk

bool operator<(IndexEntry const& b) const { return time < b.time; }
};
Expand Down

0 comments on commit ce59bdd

Please sign in to comment.