Doxygen

2020-12-01 21:03:05 +01:00
parent daaf848e0c
commit b1271cee43
1 changed files with 7 additions and 4 deletions
--- a/stm-firmware/include/reflow-controller/hw-version-detect.h
+++ b/stm-firmware/include/reflow-controller/hw-version-detect.h
@@ -3,11 +3,14 @@

 #include <stdint.h>

+/**
+ * @brief PCB/Hardware Revision Type
+ */
 enum hw_revision {
-	HW_REV_NOT_DETECTED = 0,
-	HW_REV_ERROR = 1,
-	HW_REV_V1_2 = 120,
-	HW_REV_V1_3 = 130,
+	HW_REV_NOT_DETECTED = 0, /**< @brief The hardware has'nt been detected (yet) */
+	HW_REV_ERROR = 1,	/**< @brief The hardware revision could not be detected due to an internal error */
+	HW_REV_V1_2 = 120,	/**< @brief Hardware Revision v1.2 */
+	HW_REV_V1_3 = 130,	/**< @brief Hardware Revision v1.3 */
 };

 /**