Skip to content

Commit

Permalink
DOXYGEN
Browse files Browse the repository at this point in the history
  • Loading branch information
Akashem06 committed Nov 24, 2024
1 parent 245cec4 commit 5e1ed9f
Show file tree
Hide file tree
Showing 24 changed files with 27 additions and 27 deletions.
2 changes: 1 addition & 1 deletion libraries/ms-common/inc/arm/gpio_mcu.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

/* Intra-component Headers */

/**
/**
* @defgroup GPIO
* @brief GPIO library
* @{
Expand Down
4 changes: 2 additions & 2 deletions libraries/ms-common/inc/arm/pwm_mcu.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

/* Intra-component Headers */

/**
/**
* @defgroup PWM
* @brief PWM library
* @{
Expand All @@ -25,4 +25,4 @@ typedef enum {} PwmTimer;

typedef enum {} PwmChannel;

/** @} */
/** @} */
2 changes: 1 addition & 1 deletion libraries/ms-common/inc/arm/uart_mcu.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

/* Intra-component Headers */

/**
/**
* @defgroup UART
* @brief UART library
* @{
Expand Down
4 changes: 2 additions & 2 deletions libraries/ms-common/inc/delay.h
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

/* Intra-component Headers */

/**
/**
* @defgroup RTOS_Helpers
* @brief RTOS helper libraries
* @{
Expand All @@ -40,4 +40,4 @@ void non_blocking_delay_ms(uint32_t time_ms);
*/
#define delay_s(time) delay_ms((time)*1000)

/** @} */
/** @} */
2 changes: 1 addition & 1 deletion libraries/ms-common/inc/flash.h
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
/* Intra-component Headers */
#include "status.h"

/**
/**
* @defgroup Flash
* @brief Flash library
* @{
Expand Down
2 changes: 1 addition & 1 deletion libraries/ms-common/inc/fsm.h
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
#include "status.h"
#include "tasks.h"

/**
/**
* @defgroup Finite_State_Machine
* @brief FSM library
* @{
Expand Down
2 changes: 1 addition & 1 deletion libraries/ms-common/inc/gpio.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
#include "gpio_mcu.h"
#include "status.h"

/**
/**
* @defgroup GPIO
* @brief GPIO library
* @{
Expand Down
2 changes: 1 addition & 1 deletion libraries/ms-common/inc/gpio_interrupts.h
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
#include "status.h"
#include "tasks.h"

/**
/**
* @defgroup GPIO
* @brief GPIO library
* @{
Expand Down
2 changes: 1 addition & 1 deletion libraries/ms-common/inc/interrupts.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
#include "gpio.h"
#include "status.h"

/**
/**
* @defgroup Interrupts
* @brief Interrupt library
* @{
Expand Down
2 changes: 1 addition & 1 deletion libraries/ms-common/inc/log.h
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
#include "tasks.h"
#include "uart.h"

/**
/**
* @defgroup Logger
* @brief Logging library
* @{
Expand Down
2 changes: 1 addition & 1 deletion libraries/ms-common/inc/mcu.h
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
/* Intra-component Headers*/
#include "status.h"

/**
/**
* @defgroup MCU
* @brief MCU library
* @{
Expand Down
2 changes: 1 addition & 1 deletion libraries/ms-common/inc/misc.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

/* Intra-component Headers */

/**
/**
* @defgroup Miscellaneous
* @brief Miscellaneous libraries
* @{
Expand Down
2 changes: 1 addition & 1 deletion libraries/ms-common/inc/mpu.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
/* Intra-component Headers */
#include "status.h"

/**
/**
* @defgroup Memory_Protection_Unit
* @brief MPU library
* @{
Expand Down
4 changes: 2 additions & 2 deletions libraries/ms-common/inc/notify.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
#include "status.h"
#include "tasks.h"

/**
/**
* @defgroup RTOS_Helpers
* @brief RTOS helper libraries
* @{
Expand Down Expand Up @@ -82,4 +82,4 @@ StatusCode notify(Task *task, Event event);
*/
void notify_from_isr(Task *task, Event event);

/** @} */
/** @} */
4 changes: 2 additions & 2 deletions libraries/ms-common/inc/queues.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
/* Intra-component Headers */
#include "status.h"

/**
/**
* @defgroup RTOS_Helpers
* @brief RTOS helper libraries
* @{
Expand Down Expand Up @@ -123,4 +123,4 @@ uint32_t queue_get_num_items(Queue *queue);
*/
uint32_t queue_get_spaces_available(Queue *queue);

/** @} */
/** @} */
2 changes: 1 addition & 1 deletion libraries/ms-common/inc/semaphore.h
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
/* Intra-component Headers */
#include "status.h"

/**
/**
* @defgroup RTOS_Helpers
* @brief RTOS helper libraries
* @{
Expand Down
2 changes: 1 addition & 1 deletion libraries/ms-common/inc/status.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

/* Intra-component Headers */

/**
/**
* @defgroup Status_Code
* @brief Global error library
* @{
Expand Down
2 changes: 1 addition & 1 deletion libraries/ms-common/inc/tasks.h
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
/* Intra-component Headers */
#include "status.h"

/**
/**
* @defgroup RTOS_Helpers
* @brief RTOS helper libraries
* @{
Expand Down
2 changes: 1 addition & 1 deletion libraries/ms-common/inc/test_helpers.h
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
#include "status.h"
#include "unity.h"

/**
/**
* @defgroup Miscellaneous
* @brief Miscellaneous libraries
* @{
Expand Down
2 changes: 1 addition & 1 deletion libraries/ms-common/inc/uart.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
#include "gpio.h"
#include "uart_mcu.h"

/**
/**
* @defgroup UART
* @brief UART library
* @{
Expand Down
2 changes: 1 addition & 1 deletion libraries/ms-common/inc/x86/gpio_mcu.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

/* Intra-component Headers */

/**
/**
* @defgroup GPIO
* @brief GPIO library
* @{
Expand Down
2 changes: 1 addition & 1 deletion libraries/ms-common/inc/x86/pwm_mcu.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

/* Intra-component Headers */

/**
/**
* @defgroup PWM
* @brief PWM library
* @{
Expand Down
2 changes: 1 addition & 1 deletion libraries/ms-common/inc/x86/uart_mcu.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

/* Intra-component Headers */

/**
/**
* @defgroup UART
* @brief UART library
* @{
Expand Down
Empty file removed smoke/rtos_sample/src/main.c
Empty file.

0 comments on commit 5e1ed9f

Please sign in to comment.