flash_map.h: add docstrings
Add Doxygen docstrings to struct flash_area fields.
Signed-off-by: Marti Bolivar <marti.bolivar@linaro.org>
diff --git a/boot/zephyr/include/flash_map/flash_map.h b/boot/zephyr/include/flash_map/flash_map.h
index 271c50c..eb59072 100644
--- a/boot/zephyr/include/flash_map/flash_map.h
+++ b/boot/zephyr/include/flash_map/flash_map.h
@@ -43,11 +43,35 @@
*/
#include <inttypes.h>
+/**
+ * @brief Structure describing an area on a flash device.
+ *
+ * Multiple flash devices may be available in the system, each of
+ * which may have its own areas. For this reason, flash areas track
+ * which flash device they are part of.
+ */
struct flash_area {
+ /**
+ * This flash area's ID; unique in the system.
+ */
uint8_t fa_id;
+
+ /**
+ * ID of the flash device this area is a part of.
+ */
uint8_t fa_device_id;
+
uint16_t pad16;
+
+ /**
+ * This area's offset, relative to the beginning of its flash
+ * device's storage.
+ */
uint32_t fa_off;
+
+ /**
+ * This area's size, in bytes.
+ */
uint32_t fa_size;
};