liblzma: Add comments for macros in delta.h.

Document LZMA_DELTA_DIST_MIN and LZMA_DELTA_DIST_MAX for completeness and to avoid Doxygen warnings.
2023-02-10 21:38:02 +08:00 · 2023-02-10 21:38:02 +08:00 · 90d0e628ff
parent 9255fffdb1
commit 90d0e628ff
1 changed files with 8 additions and 0 deletions
--- a/src/liblzma/api/lzma/delta.h
+++ b/src/liblzma/api/lzma/delta.h
@ -58,7 +58,15 @@ typedef struct {
 	 *  - 24-bit RGB image data: distance = 3 bytes
 	 */
 	uint32_t dist;
+
+	/**
+	 * \brief       Minimum value for the dist field in lzma_options_delta.
+	 */
 #	define LZMA_DELTA_DIST_MIN 1
+
+	/** 
+	 * \brief       Maximum value for the dist field in lzma_options_delta.
+	 */
 #	define LZMA_DELTA_DIST_MAX 256

 	/*