Renamed clock-enable manager to rcc manager and improve some header files with doxygen comments

stm-firmware/include/reflow-controller/safety/safety-config.h

@@ -18,10 +18,21 @@
 * If not, see <http://www.gnu.org/licenses/>.
 */
 
+/**
+ * @file safety-config.h
+ * @brief Safety Controller Configuration.
+ * @warning MAKE SURE XOU UNDERSTAND WHAT YOU ARE DOING IN HERE
+ */
+
 #ifndef __SAFETY_CONFIG_H__
 #define __SAFETY_CONFIG_H__
 
-
+/**
+ * @brief Enum type representing safety flags.
+ *
+ * The enum type is binary or'able to allow combining
+ * multiple safety flags.
+ */
 enum safety_flag {
 	ERR_FLAG_NO_FLAG = 0,
 	ERR_FLAG_MEAS_ADC_OFF = (1<<0),
@@ -43,6 +54,12 @@ enum safety_flag {
 	ERR_FLAG_SAFETY_TAB_CORRUPT = (1<<16),
 };
 
+/**
+ * @brief Enum Type representing timing monitors.
+ *
+ * The enum type is binary or'able to allow combining
+ * multiple safety flags.
+ */
 enum timing_monitor {
 	ERR_TIMING_PID = (1<<0),
 	ERR_TIMING_MEAS_ADC = (1<<1),
@@ -50,6 +67,12 @@ enum timing_monitor {
 	ERR_TIMING_MAIN_LOOP = (1<<3),
 };
 
+/**
+ * @brief Enum Type representing analog value monitors.
+ *
+ * The enum type is binary or'able to allow combining
+ * multiple safety flags.
+ */
 enum analog_value_monitor {
 	ERR_AMON_VREF = (1<<0),
 	ERR_AMON_UC_TEMP = (1<<1),
@@ -97,10 +120,13 @@ enum analog_value_monitor {
 
 
 /**
- * @brief Key used to lock the safety flags from external ack'ing
+ * @brief Key used to lock the safety flags coming from the measurment ADC from external ack'ing
  */
 #define MEAS_ADC_SAFETY_FLAG_KEY 0xe554dac3UL
 
+/**
+ * @brief Safety ADC trigger interval
+ */
 #define SAFETY_CONTROLLER_ADC_DELAY_MS 250
 
 #define SAFETY_CONFIG_DEFAULT_PERSIST	ERR_FLAG_PERSIST_ENTRY(ERR_FLAG_MEAS_ADC_OFF, false), \