summaryrefslogtreecommitdiff
path: root/include/sqfs/data.h
diff options
context:
space:
mode:
authorDavid Oberhollenzer <david.oberhollenzer@sigma-star.at>2019-09-09 23:11:03 +0200
committerDavid Oberhollenzer <david.oberhollenzer@sigma-star.at>2019-09-09 23:12:08 +0200
commitc17de5d4c2699c6c5b4759f009ce8cb6560d2f13 (patch)
treeca36c1af536583856360dd6e905fe7143ee5a562 /include/sqfs/data.h
parent524869a644004b2b5eae9c6cdb14a20c0e877778 (diff)
Add doxygen annotations to all public headers
Signed-off-by: David Oberhollenzer <david.oberhollenzer@sigma-star.at>
Diffstat (limited to 'include/sqfs/data.h')
-rw-r--r--include/sqfs/data.h23
1 files changed, 23 insertions, 0 deletions
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;
};