Add comment to function

2022-07-30 15:52:47 +02:00 · 2022-07-30 15:52:47 +02:00 · 7a36b597be
commit 7a36b597be
parent 00b8d1f48e
1 changed files with 4 additions and 0 deletions
--- a/stm-firmware/safety/safety-controller.c
+++ b/stm-firmware/safety/safety-controller.c
@ -364,6 +364,10 @@ static void set_overtemp_config(float over_temperature)
 	safety_controller_overtemp_config.crc = crc_unit_get_crc();
 }

+/**
+ * @brief Check the overtemperature config structure's CRC
+ * @return true if check failed. false if CRC check successful
+ */
 static bool over_temperature_config_check(void)
 {
 	if (safety_controller_overtemp_config.crc_dummy_seed != 0xA4F5C7E6UL)