From c17de5d4c2699c6c5b4759f009ce8cb6560d2f13 Mon Sep 17 00:00:00 2001 From: David Oberhollenzer Date: Mon, 9 Sep 2019 23:11:03 +0200 Subject: Add doxygen annotations to all public headers Signed-off-by: David Oberhollenzer --- include/sqfs/data.h | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) (limited to 'include/sqfs/data.h') diff --git a/include/sqfs/data.h b/include/sqfs/data.h index 818d427..70f285f 100644 --- a/include/sqfs/data.h +++ b/include/sqfs/data.h @@ -22,15 +22,38 @@ #include "sqfs/predef.h" +/** + * @file data.h + * + * @brief Contains on-disk data structures for data block management + * and helper macros. + */ + #define SQFS_META_BLOCK_SIZE 8192 #define SQFS_IS_BLOCK_COMPRESSED(size) (((size) & (1 << 24)) == 0) #define SQFS_ON_DISK_BLOCK_SIZE(size) ((size) & ((1 << 24) - 1)) #define SQFS_IS_SPARSE_BLOCK(size) (SQFS_ON_DISK_BLOCK_SIZE(size) == 0) +/** + * @struct sqfs_fragment_t + * + * @brief Data structure that makes up the fragment table entries. + */ struct sqfs_fragment_t { + /** + * @brief Location of the fragment block on-disk. + */ uint64_t start_offset; + + /** + * @brief Size of the fragment block in bytes. + */ uint32_t size; + + /** + * @brief Unused. Always initialize this to 0. + */ uint32_t pad0; }; -- cgit v1.2.3