Improve documentation for storage utilities

src/storage.c

@@ -23,6 +23,8 @@
 #include "pd.h"
 
 
+/* Initialize the location of the configuration array.  PDB_CONFIG_BASE is set
+ * in the Makefile. */
 struct pdb_config *pdb_config_array = (struct pdb_config *) PDB_CONFIG_BASE;
 
 

src/storage.h

@@ -37,10 +37,10 @@ struct pdb_config {
     uint16_t _reserved[2];
 } __attribute__((packed));
 
-/* Status for configuration structures.  The empty status indicates that the
- * struct is ready to be written, including an update to the valid status.
- * Once the struct is no longer needed, the status is updated to invalid.
- * Erasing the flash page resets all structures to the empty status. */
+/* Status for configuration structures.  EMPTY indicates that the struct is
+ * ready to be written, including a status update to VALID.  Once the struct is
+ * no longer needed, the status is updated to INVALID.  Erasing the flash page
+ * resets all structures to EMPTY. */
 #define PDB_CONFIG_STATUS_INVALID 0x0000
 #define PDB_CONFIG_STATUS_VALID 0xBEEF
 #define PDB_CONFIG_STATUS_EMPTY 0xFFFF