From cfbe60d6908fc56dcdcfa03dd3a321ab26d76ef3 Mon Sep 17 00:00:00 2001
From: Stefano Moioli <smxdev4@gmail.com>
Date: Thu, 4 Apr 2024 01:00:04 +0200
Subject: [PATCH] fix documentation for secret_data_shift_cursor

---
 xzre.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/xzre.h b/xzre.h
index 4eacf49..43a0910 100644
--- a/xzre.h
+++ b/xzre.h
@@ -186,8 +186,9 @@ assert_offset(elf_info_t, gnu_hash_chain, 0xf8);
  */
 typedef union {
 	struct {
-		/** NOTE: little endian bitfield ordering */
+		/** bit index in the current byte indicated by @ref byte_index */
 		u32 bit_index : 3;
+		/** byte index into the secret data array*/
 		u32 byte_index : 29;
 	};
 	/** the initial value */