Manually looked through the files, applied copyright

lhr-solar · Sep 30, 2023 · e357a69 · e357a69
1 parent 4238ce9
commit e357a69
Show file tree

Hide file tree

Showing 76 changed files with 226 additions and 155 deletions.
diff --git a/Apps/Inc/CAN_Queue.h b/Apps/Inc/CAN_Queue.h
@@ -1,6 +1,6 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file CAN_Queue.h
  * @brief Queue that holds all CAN messages that Task_CANBusConsumer needs to
  * send.
  *

diff --git a/Apps/Inc/FaultState.h b/Apps/Inc/FaultState.h
@@ -1,12 +1,13 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file FaultState.h
  * @brief
  *
  * @defgroup FaultState
  * @addtogroup FaultState
  * @{
  */
+
 #ifndef __FAULT_STATE_H
 #define __FAULT_STATE_H
 

diff --git a/Apps/Inc/MedianFilter.h b/Apps/Inc/MedianFilter.h
@@ -1,15 +1,7 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file MedianFilter.h
- * @brief
- *
- * @defgroup MedianFilter
- * @addtogroup MedianFilter
- * @{
- */
-
-/*
- * This file implements a median filter.
+ * @brief This file implements a median filter.
  *
  * In order to use it in another file, you must import it in
  * a particular way.
@@ -37,6 +29,10 @@
  * NOTE: importantly, this does not currently support usage from
  * header files. That is, all these types/functions are statically
  * declared, so there cannot be a non-static fifo at the moment.
+ *
+ * @defgroup MedianFilter
+ * @addtogroup MedianFilter
+ * @{
  */
 
 // The header guard only guard the import,
@@ -220,4 +216,4 @@ GETSINGLE(MF_TYPE_NAME *filter, uint32_t channel) {
 #undef PUT
 #undef GETSINGLE
 
-/* @} */
+/* @} */
diff --git a/Apps/Inc/ReadCarCAN.h b/Apps/Inc/ReadCarCAN.h
@@ -1,6 +1,6 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file ReadCarCAN.h
  * @brief
  *
  * @defgroup ReadCarCAN

diff --git a/Apps/Inc/ReadTritium.h b/Apps/Inc/ReadTritium.h
@@ -1,6 +1,6 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file ReadTritium.h
  * @brief
  *
  * @defgroup ReadTritium

diff --git a/Apps/Inc/SendTritium.h b/Apps/Inc/SendTritium.h
@@ -1,12 +1,13 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file SendTritium.h
  * @brief
  *
  * @defgroup SendTritium
  * @addtogroup SendTritium
  * @{
  */
+
 #ifndef __SENDTRITIUM_H
 #define __SENDTRITIUM_H
 

diff --git a/Apps/Inc/Tasks.h b/Apps/Inc/Tasks.h
@@ -1,6 +1,6 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file Tasks.h
  * @brief
  *
  * @defgroup Tasks
@@ -205,4 +205,4 @@ void _assertOSError(
 
 #endif
 
-/* @} */
+/* @} */
diff --git a/Apps/Inc/UpdateDisplay.h b/Apps/Inc/UpdateDisplay.h
@@ -1,6 +1,6 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file UpdateDisplay.h
  * @brief Function prototypes for the display application.
  *
  * This contains function prototypes relevant to the UpdateDisplay
@@ -53,7 +53,6 @@ typedef enum { STATE_0 = 0, STATE_1 = 1, STATE_2 = 2 } TriState_t;
  * @brief Initializes UpdateDisplay application
  * @returns UpdateDisplayError_t
  */
-
 UpdateDisplayError_t UpdateDisplay_Init();
 
 /**
@@ -129,4 +128,4 @@ UpdateDisplayError_t UpdateDisplay_SetCruiseState(TriState_t state);
 
 #endif
 
-/* @} */
+/* @} */
diff --git a/Apps/Inc/common.h b/Apps/Inc/common.h
@@ -1,6 +1,6 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file common.h
  * @brief
  *
  * @defgroup common

diff --git a/Apps/Inc/fifo.h b/Apps/Inc/fifo.h
@@ -1,15 +1,7 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file fifo.h
- * @brief
- *
- * @defgroup fifo
- * @addtogroup fifo
- * @{
- */
-
-/*
- * This file implements a fifo.
+ * @brief This file implements a fifo.
  *
  * In order to use it in another file, you must import it in
  * a particular way.
@@ -35,6 +27,10 @@
  * NOTE: importantly, this does not currently support usage from
  * header files. That is, all these types/functions are statically
  * declared, so there cannot be a non-static fifo at the moment.
+ *
+ * @defgroup fifo
+ * @addtogroup fifo
+ * @{
  */
 
 // The header guard only guard the import,
@@ -236,4 +232,5 @@ POPBACK(FIFO_TYPE_NAME *fifo, FIFO_TYPE *elem) {
 #undef POPBACK
 #undef CONCAT
 #undef _CONCAT
+
 /* @} */
diff --git a/Apps/Src/CAN_Queue.c b/Apps/Src/CAN_Queue.c
@@ -1,8 +1,6 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file CAN_Queue.c
- * @brief
- *
  */
 
 #include "CAN_Queue.h"

diff --git a/Apps/Src/CommandLine.c b/Apps/Src/CommandLine.c
@@ -1,3 +1,8 @@
+/**
+ * @file
+ * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
+ */
+
 #include <stdbool.h>
 #include <stdint.h>
 #include <stdlib.h>

diff --git a/Apps/Src/DebugDump.c b/Apps/Src/DebugDump.c
@@ -1,3 +1,8 @@
+/**
+ * @file
+ * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
+ */
+
 #include <errno.h>
 
 #include "CAN_Queue.h"
@@ -105,4 +110,4 @@ void Task_DebugDump(void *p_arg) {
       assertOSError(OS_NONE_LOC, err);
     }
   }
-}
+}
diff --git a/Apps/Src/FaultState.c b/Apps/Src/FaultState.c
@@ -1,8 +1,6 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file FaultState.c
- * @brief
- *
  */
 
 #include "FaultState.h"

diff --git a/Apps/Src/PedalToPercent.c b/Apps/Src/PedalToPercent.c
@@ -1,8 +1,6 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file PedalToPercent.c
- * @brief
- *
  */
 
 /* Converts accelerator pedal percentage to a decimal */

diff --git a/Apps/Src/ReadCarCAN.c b/Apps/Src/ReadCarCAN.c
@@ -1,8 +1,6 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file ReadCarCAN.c
- * @brief
- *
  */
 
 #include "ReadCarCAN.h"

diff --git a/Apps/Src/ReadTritium.c b/Apps/Src/ReadTritium.c
@@ -1,8 +1,6 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file ReadTritium.c
- * @brief
- *
  */
 
 #include "ReadTritium.h"

diff --git a/Apps/Src/SendCarCAN.c b/Apps/Src/SendCarCAN.c
@@ -1,6 +1,6 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file SendCarCAN.c
  * @brief Implements the SendCarCAN Task
  *
  * Resends the feedback from the motor controller

diff --git a/Apps/Src/SendTritium.c b/Apps/Src/SendTritium.c
@@ -1,6 +1,6 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file SendTritium.c
  * @brief Function implementations for the SendTritium application.
  *
  * This contains functions relevant to updating the velocity and current

diff --git a/Apps/Src/Tasks.c b/Apps/Src/Tasks.c
@@ -1,8 +1,6 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file Tasks.c
- * @brief
- *
  */
 
 #include "Tasks.h"

diff --git a/Apps/Src/Telemetry.c b/Apps/Src/Telemetry.c
@@ -1,6 +1,6 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file Telemetry.c
  * @brief Implements the SendCarCAN Task
  *
  * Creates a datatype to house the data to be read by telemetry

diff --git a/Apps/Src/UpdateDisplay.c b/Apps/Src/UpdateDisplay.c
@@ -1,6 +1,6 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file UpdateDisplay.c
  * @brief Function implementations for the display application.
  *
  * This contains functions relevant to modifying states of specific

diff --git a/Apps/Src/common.c b/Apps/Src/common.c
@@ -1,3 +1,8 @@
+/**
+ * @file
+ * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
+ */
+
 #include "common.h"
 
 void print_float(char* str, float f) {

diff --git a/Apps/Src/main.c b/Apps/Src/main.c
@@ -1,8 +1,6 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file main.c
- * @brief
- *
  */
 
 #include "CANConfig.h"

diff --git a/BSP/Inc/BSP_ADC.h b/BSP/Inc/BSP_ADC.h
@@ -1,6 +1,6 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file BSP_ADC.h
  * @brief Header file for the library to interact
  * with the Analog to Digital Converter (ADC)
  *

diff --git a/BSP/Inc/BSP_CAN.h b/BSP/Inc/BSP_CAN.h
@@ -1,6 +1,6 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file BSP_CAN.h
  * @brief Header file for the library to interact
  * with both CAN lines in the car
  *

diff --git a/BSP/Inc/BSP_GPIO.h b/BSP/Inc/BSP_GPIO.h
@@ -1,6 +1,6 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file BSP_GPIO.h
  * @brief Header file for the library to interact
  * with the GPIO ports
  *

diff --git a/BSP/Inc/BSP_OS.h b/BSP/Inc/BSP_OS.h
@@ -1,6 +1,6 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file BSP_OS.h
  * @brief
  *
  * @defgroup BSP_OS

diff --git a/BSP/Inc/BSP_SPI.h b/BSP/Inc/BSP_SPI.h
@@ -1,6 +1,6 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file BSP_SPI.h
  * @brief Header file for the library to interact
  * over SPI with minion board(s)
  *

diff --git a/BSP/Inc/BSP_UART.h b/BSP/Inc/BSP_UART.h
@@ -1,6 +1,6 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file BSP_UART.h
  * @brief Header file for the library to interact
  * with the UART line
  *

diff --git a/BSP/Inc/bsp.h b/BSP/Inc/bsp.h
@@ -1,6 +1,6 @@
 /**
+ * @file
  * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
- * @file bsp.h
  * @brief
  *
  * @defgroup bsp

diff --git a/BSP/STM32F413/Src/BSP_ADC.c b/BSP/STM32F413/Src/BSP_ADC.c
@@ -1,4 +1,7 @@
-/* Copyright (c) 2020 UT Longhorn Racing Solar */
+/**
+ * @file
+ * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
+ */
 
 #include "BSP_ADC.h"
 

diff --git a/BSP/STM32F413/Src/BSP_CAN.c b/BSP/STM32F413/Src/BSP_CAN.c
@@ -1,4 +1,7 @@
-/* Copyright (c) 2020 UT Longhorn Racing Solar */
+/**
+ * @file
+ * @copyright Copyright (c) 2018-2023 UT Longhorn Racing Solar
+ */
 
 #include "BSP_CAN.h"