From b1271cee4307bed65257d0a296e9bb12c017822a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mario=20H=C3=BCttel?= Date: Tue, 1 Dec 2020 21:03:05 +0100 Subject: [PATCH] Doxygen --- .../include/reflow-controller/hw-version-detect.h | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/stm-firmware/include/reflow-controller/hw-version-detect.h b/stm-firmware/include/reflow-controller/hw-version-detect.h index cb94afd..2f7593e 100644 --- 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 +/** + * @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 */ }; /**