Improve documentation and beatify pieces of code

stm-firmware/include/reflow-controller/hw-version-detect.h

@@ -1,8 +1,54 @@
+/* Reflow Oven Controller
+*
+* Copyright (C) 2021  Mario Hüttel <mario.huettel@gmx.net>
+*
+* This file is part of the Reflow Oven Controller Project.
+*
+* The reflow oven controller is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License version 2 as
+* published by the Free Software Foundation.
+*
+* The Reflow Oven Control Firmware is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with the reflow oven controller project.
+* If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/**
+ * @addtogroup hw-version-detect
+ * @{
+ */
+
 #ifndef _HW_VERSION_DETECT_H_
 #define _HW_VERSION_DETECT_H_
 
 #include <stdint.h>
 
+/**
+ * @brief GPIO Port used for hardware version detection
+ */
+#define HW_REV_DETECT_GPIO GPIOE
+
+/**
+ * @brief RCC Clock register mask used to enable @ref HW_REV_DETECT_GPIO GPIO Port
+ */
+#define HW_REV_DETECT_RCC_FIELD RCC_AHB1ENR_GPIOEEN
+
+/**
+ * @brief Lowest pin on @ref HW_REV_DETECT_GPIO GPIO Port that shall be used to read in the hardware version
+ */
+#define HW_REV_DETECT_PIN_LOW (8U)
+
+/**
+ * @brief Highest pin on @ref HW_REV_DETECT_GPIO GPIO Port that shall be used to read in the hardware version
+ */
+#define HW_REV_DETECT_PIN_HIGH (15U)
+
+
 /**
  * @brief PCB/Hardware Revision Type
  */
@@ -32,3 +78,5 @@ enum hw_revision {
 enum hw_revision get_pcb_hardware_version(void);
 
 #endif /* _HW_VERSION_DETECT_H_ */
+
+/** @} */

stm-firmware/include/reflow-controller/settings/settings.h

@@ -18,7 +18,6 @@
 * If not, see <http://www.gnu.org/licenses/>.
 */
 
-
 #ifndef __SETTINGS_SETTINGS_H__
 #define __SETTINGS_SETTINGS_H__