aboutsummaryrefslogtreecommitdiff
path: root/module
diff options
context:
space:
mode:
authorChris Kay <chris.kay@arm.com>2020-09-28 12:20:35 +0100
committerjimqui01 <54316584+jimqui01@users.noreply.github.com>2020-10-02 14:19:09 +0100
commit3361c3269a4c6b053a39766c945a8be1611ce5c7 (patch)
tree418486f631b259021af500475b2fb6e773ba990a /module
parent8d2dafa877386947f8ffadff97767114a55efe62 (diff)
docs: Prefer `\` to `@` in Doxygen comments
This commit replaces any instances of `@`-style Doxygen commands with their `\`-style equivalents. This is done for consistency across the codebase. The `\sa` Doxygen command has been added to the Clang-Format configuration to prevent it from reflowing see-also comments, which often exceed the column limit due to referring to long URLs. Change-Id: Ia4ebe8bd310293da9e2af55fe253f0762807e88a Signed-off-by: Chris Kay <chris.kay@arm.com>
Diffstat (limited to 'module')
-rw-r--r--module/bootloader/include/mod_bootloader.h8
-rw-r--r--module/clock/include/mod_clock.h8
-rw-r--r--module/cmn600/include/mod_cmn600.h8
-rw-r--r--module/cmn_booker/include/mod_cmn_booker.h8
-rw-r--r--module/cmn_rhodes/include/mod_cmn_rhodes.h8
-rw-r--r--module/css_clock/include/mod_css_clock.h8
-rw-r--r--module/ddr_phy500/include/mod_ddr_phy500.h12
-rw-r--r--module/debug/include/mod_debug.h2
-rw-r--r--module/dmc500/include/mod_dmc500.h16
-rw-r--r--module/dmc620/include/mod_dmc620.h60
-rw-r--r--module/dw_apb_i2c/include/mod_dw_apb_i2c.h8
-rw-r--r--module/fip/include/mod_fip.h2
-rw-r--r--module/gtimer/include/mod_gtimer.h8
-rw-r--r--module/i2c/include/mod_i2c.h8
-rw-r--r--module/mhu/include/mod_mhu.h8
-rw-r--r--module/mhu2/include/mod_mhu2.h8
-rw-r--r--module/msys_rom/include/mod_msys_rom.h6
-rw-r--r--module/pcid/include/mod_pcid.h8
-rw-r--r--module/pik_clock/include/mod_pik_clock.h8
-rw-r--r--module/power_domain/include/mod_power_domain.h8
-rw-r--r--module/power_domain/include/power_domain_utils.h4
-rw-r--r--module/ppu_v0/include/mod_ppu_v0.h8
-rw-r--r--module/ppu_v0/src/ppu_v0.h4
-rw-r--r--module/ppu_v1/include/mod_ppu_v1.h8
-rw-r--r--module/ppu_v1/src/ppu_v1.h4
-rw-r--r--module/reg_sensor/include/mod_reg_sensor.h8
-rw-r--r--module/scmi/include/internal/scmi.h4
-rw-r--r--module/scmi/include/mod_scmi.h8
-rw-r--r--module/scmi/include/mod_scmi_std.h8
-rw-r--r--module/scmi_perf/include/mod_scmi_perf.h10
-rw-r--r--module/scmi_power_domain/include/internal/scmi_power_domain.h8
-rw-r--r--module/scmi_sensor/include/internal/scmi_sensor.h8
-rw-r--r--module/scmi_system_power/include/mod_scmi_system_power.h10
-rw-r--r--module/sds/include/mod_sds.h8
-rw-r--r--module/sensor/include/mod_sensor.h8
-rw-r--r--module/sensor/src/sensor.h4
-rw-r--r--module/sid/include/mod_sid.h8
-rw-r--r--module/smt/include/mod_smt.h4
-rw-r--r--module/system_info/include/mod_system_info.h8
-rw-r--r--module/system_pll/include/mod_system_pll.h6
-rw-r--r--module/system_power/include/mod_system_power.h4
-rw-r--r--module/timer/include/mod_timer.h8
42 files changed, 180 insertions, 180 deletions
diff --git a/module/bootloader/include/mod_bootloader.h b/module/bootloader/include/mod_bootloader.h
index b7b56228..65960644 100644
--- a/module/bootloader/include/mod_bootloader.h
+++ b/module/bootloader/include/mod_bootloader.h
@@ -15,7 +15,7 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
@@ -23,7 +23,7 @@
*
* \details A service module providing support for loading firmware images.
*
- * @{
+ * \{
*/
/*!
@@ -98,11 +98,11 @@ struct mod_bootloader_api {
};
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_BOOTLOADER_H */
diff --git a/module/clock/include/mod_clock.h b/module/clock/include/mod_clock.h
index 4dbd52d1..6aa53d20 100644
--- a/module/clock/include/mod_clock.h
+++ b/module/clock/include/mod_clock.h
@@ -16,7 +16,7 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
@@ -24,7 +24,7 @@
*
* \details A Hardware Abstraction Layer for configuring clock devices.
*
- * @{
+ * \{
*/
/*!
@@ -581,11 +581,11 @@ static const fwk_id_t mod_clock_event_id_get_state_request =
MOD_CLOCK_EVENT_IDX_GET_STATE_REQUEST);
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_CLOCK_H */
diff --git a/module/cmn600/include/mod_cmn600.h b/module/cmn600/include/mod_cmn600.h
index a2016a4e..63222a39 100644
--- a/module/cmn600/include/mod_cmn600.h
+++ b/module/cmn600/include/mod_cmn600.h
@@ -16,7 +16,7 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
@@ -25,7 +25,7 @@
* \brief Arm Coherent Mesh Network (CMN) 600 module
*
* \details This module adds support for the CMN600 interconnect
- * @{
+ * \{
*/
/*!
@@ -305,11 +305,11 @@ struct mod_cmn600_ccix_config_api {
};
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_CMN600_H */
diff --git a/module/cmn_booker/include/mod_cmn_booker.h b/module/cmn_booker/include/mod_cmn_booker.h
index 7ca0d791..28e5c53b 100644
--- a/module/cmn_booker/include/mod_cmn_booker.h
+++ b/module/cmn_booker/include/mod_cmn_booker.h
@@ -16,7 +16,7 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
@@ -25,7 +25,7 @@
* \brief Arm Coherent Mesh Network (CMN) BOOKER module
*
* \details This module adds support for the CMN_BOOKER interconnect
- * @{
+ * \{
*/
/*!
@@ -131,11 +131,11 @@ struct mod_cmn_booker_config {
};
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_CMN_BOOKER_H */
diff --git a/module/cmn_rhodes/include/mod_cmn_rhodes.h b/module/cmn_rhodes/include/mod_cmn_rhodes.h
index 902f4a27..123692ff 100644
--- a/module/cmn_rhodes/include/mod_cmn_rhodes.h
+++ b/module/cmn_rhodes/include/mod_cmn_rhodes.h
@@ -16,7 +16,7 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
@@ -25,7 +25,7 @@
* \brief Arm Coherent Mesh Network (CMN) RHODES module
*
* \details This module adds support for the CMN_RHODES interconnect
- * @{
+ * \{
*/
/*! Maximum CCIX Protocol Links supported by CCIX Gateway (CXG) */
@@ -258,11 +258,11 @@ struct mod_cmn_rhodes_config {
};
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_CMN_RHODES_H */
diff --git a/module/css_clock/include/mod_css_clock.h b/module/css_clock/include/mod_css_clock.h
index 3dbce6ac..3b5cbd0e 100644
--- a/module/css_clock/include/mod_css_clock.h
+++ b/module/css_clock/include/mod_css_clock.h
@@ -16,7 +16,7 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
@@ -24,7 +24,7 @@
*
* \details A driver for Arm Compute Sub-System clock devices.
*
- * @{
+ * \{
*/
/*!
@@ -184,11 +184,11 @@ struct mod_css_clock_direct_api {
};
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_CSS_CLOCK_H */
diff --git a/module/ddr_phy500/include/mod_ddr_phy500.h b/module/ddr_phy500/include/mod_ddr_phy500.h
index e7ec4384..68b72f3a 100644
--- a/module/ddr_phy500/include/mod_ddr_phy500.h
+++ b/module/ddr_phy500/include/mod_ddr_phy500.h
@@ -19,12 +19,12 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
* \addtogroup GroupDDR DDR PHY500 Driver
- * @{
+ * \{
*/
/*!
@@ -33,7 +33,7 @@
struct mod_ddr_phy500_reg {
/*!
* \cond
- * @{
+ * \{
*/
FWK_RW uint32_t INIT_COMPLETE;
FWK_RW uint32_t MEMORY_WIDTH;
@@ -61,7 +61,7 @@ struct mod_ddr_phy500_reg {
FWK_RW uint32_t T_CTRL_UPD_MIN;
/*!
* \endcond
- * @}
+ * \}
*/
};
@@ -98,11 +98,11 @@ struct mod_ddr_phy500_module_config {
};
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_DDR_PHY500_H */
diff --git a/module/debug/include/mod_debug.h b/module/debug/include/mod_debug.h
index 46482b4f..b1b61cea 100644
--- a/module/debug/include/mod_debug.h
+++ b/module/debug/include/mod_debug.h
@@ -241,6 +241,6 @@ static const fwk_id_t mod_debug_event_id_req_enable_set =
MOD_DEBUG_PUBLIC_EVENT_IDX_REQ_ENABLE_SET);
/*!
- * @}
+ * \}
*/
#endif /* MOD_DEBUG_H */
diff --git a/module/dmc500/include/mod_dmc500.h b/module/dmc500/include/mod_dmc500.h
index 8c73b548..c080ad50 100644
--- a/module/dmc500/include/mod_dmc500.h
+++ b/module/dmc500/include/mod_dmc500.h
@@ -21,7 +21,7 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
@@ -30,7 +30,7 @@
* \details Please consult the Arm CoreLink DMC-500 Dynamic Memory Controller
* Technical Reference Manual for details on the specific registers that
* are programmed here.
- * @{
+ * \{
*/
/*!
@@ -39,7 +39,7 @@
struct mod_dmc500_reg {
/*!
* \cond
- * @{
+ * \{
*/
FWK_R uint32_t SI0_SI_STATUS;
FWK_R uint32_t SI0_SI_INTERRUPT_STATUS;
@@ -408,9 +408,9 @@ struct mod_dmc500_reg {
FWK_R uint32_t COMPONENT_ID_2;
FWK_R uint32_t COMPONENT_ID_3;
/*!
- * \endcond
- * @}
- */
+ * \endcond
+ * \}
+ */
};
/*!
@@ -560,11 +560,11 @@ struct mod_dmc500_module_config {
extern const struct fwk_module module_dmc500;
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_DMC500_H */
diff --git a/module/dmc620/include/mod_dmc620.h b/module/dmc620/include/mod_dmc620.h
index 255e42cd..502d875a 100644
--- a/module/dmc620/include/mod_dmc620.h
+++ b/module/dmc620/include/mod_dmc620.h
@@ -19,7 +19,7 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
@@ -30,7 +30,7 @@
* are programmed here.
*
* \sa https://developer.arm.com/docs/100568/latest/programmers-model/register-summary
- * @{
+ * \{
*/
/*!
@@ -44,16 +44,16 @@
struct mod_dmc620_access_address_next {
/*!
* \cond
- * @{
+ * \{
*/
FWK_RW uint32_t MIN_31_00;
FWK_RW uint32_t MIN_43_32;
FWK_RW uint32_t MAX_31_00;
FWK_RW uint32_t MAX_43_32;
/*!
- * \endcond
- * @}
- */
+ * \endcond
+ * \}
+ */
};
/*!
@@ -62,16 +62,16 @@ struct mod_dmc620_access_address_next {
struct mod_dmc620_access_address_now {
/*!
* \cond
- * @{
+ * \{
*/
FWK_R uint32_t MIN_31_00;
FWK_R uint32_t MIN_43_32;
FWK_R uint32_t MAX_31_00;
FWK_R uint32_t MAX_43_32;
/*!
- * \endcond
- * @}
- */
+ * \endcond
+ * \}
+ */
};
/*!
@@ -80,22 +80,22 @@ struct mod_dmc620_access_address_now {
struct mod_dmc620_pmu_counter {
/*!
* \cond
- * @{
+ * \{
*/
- FWK_RW uint32_t MASK_31_00;
- FWK_RW uint32_t MASK_63_32;
- FWK_RW uint32_t MATCH_31_00;
- FWK_RW uint32_t MATCH_63_32;
- FWK_RW uint32_t CONTROL;
- uint32_t RESERVED0;
- FWK_R uint32_t SNAPSHOT_VALUE_31_00;
- uint32_t RESERVED1;
- FWK_RW uint32_t VALUE_31_00;
- uint32_t RESERVED2;
+ FWK_RW uint32_t MASK_31_00;
+ FWK_RW uint32_t MASK_63_32;
+ FWK_RW uint32_t MATCH_31_00;
+ FWK_RW uint32_t MATCH_63_32;
+ FWK_RW uint32_t CONTROL;
+ uint32_t RESERVED0;
+ FWK_R uint32_t SNAPSHOT_VALUE_31_00;
+ uint32_t RESERVED1;
+ FWK_RW uint32_t VALUE_31_00;
+ uint32_t RESERVED2;
/*!
- * \endcond
- * @}
- */
+ * \endcond
+ * \}
+ */
};
/*!
@@ -104,7 +104,7 @@ struct mod_dmc620_pmu_counter {
struct mod_dmc620_reg {
/*!
* \cond
- * @{
+ * \{
*/
FWK_R uint32_t MEMC_STATUS;
FWK_R uint32_t MEMC_CONFIG;
@@ -559,9 +559,9 @@ struct mod_dmc620_reg {
FWK_R uint32_t COMPONENT_ID_2;
FWK_R uint32_t COMPONENT_ID_3;
/*!
- * \endcond
- * @}
- */
+ * \endcond
+ * \}
+ */
};
/*!
@@ -662,11 +662,11 @@ struct mod_dmc620_module_config {
extern const struct fwk_module module_dmc620;
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_DMC620_H */
diff --git a/module/dw_apb_i2c/include/mod_dw_apb_i2c.h b/module/dw_apb_i2c/include/mod_dw_apb_i2c.h
index 3e662379..1ddd86f8 100644
--- a/module/dw_apb_i2c/include/mod_dw_apb_i2c.h
+++ b/module/dw_apb_i2c/include/mod_dw_apb_i2c.h
@@ -18,14 +18,14 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
* \defgroup GroupModuleI2CController I2C Controller
*
* \brief Driver for I2C device.
- * @{
+ * \{
*/
/*!
@@ -55,11 +55,11 @@ static const fwk_id_t mod_dw_apb_i2c_api_id_driver = FWK_ID_API_INIT(
FWK_MODULE_IDX_DW_APB_I2C, MOD_DW_APB_I2C_API_IDX_DRIVER);
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_DW_APB_I2C_H */
diff --git a/module/fip/include/mod_fip.h b/module/fip/include/mod_fip.h
index de6d8341..57b90bb0 100644
--- a/module/fip/include/mod_fip.h
+++ b/module/fip/include/mod_fip.h
@@ -17,7 +17,7 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
diff --git a/module/gtimer/include/mod_gtimer.h b/module/gtimer/include/mod_gtimer.h
index ff826a72..64b76b28 100644
--- a/module/gtimer/include/mod_gtimer.h
+++ b/module/gtimer/include/mod_gtimer.h
@@ -17,7 +17,7 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
@@ -25,7 +25,7 @@
*
* \details Driver module for the generic timer.
*
- * @{
+ * \{
*/
/*!
@@ -64,11 +64,11 @@ struct fwk_time_driver mod_gtimer_driver(
const struct mod_gtimer_dev_config *cfg);
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_GTIMER_H */
diff --git a/module/i2c/include/mod_i2c.h b/module/i2c/include/mod_i2c.h
index cd381c19..30e4ba4f 100644
--- a/module/i2c/include/mod_i2c.h
+++ b/module/i2c/include/mod_i2c.h
@@ -22,7 +22,7 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
@@ -30,7 +30,7 @@
*
* \details Support for transmitting and receiving data through I2C Bus
* peripherals
- * @{
+ * \{
*/
/*!
@@ -284,11 +284,11 @@ static const fwk_id_t mod_i2c_event_id_request_tx_rx = FWK_ID_EVENT_INIT(
*/
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_I2C_H */
diff --git a/module/mhu/include/mod_mhu.h b/module/mhu/include/mod_mhu.h
index d433ad6b..935cef97 100644
--- a/module/mhu/include/mod_mhu.h
+++ b/module/mhu/include/mod_mhu.h
@@ -17,12 +17,12 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
* \defgroup GroupMHU Message Handling Unit (MHU) Driver
- * @{
+ * \{
*/
/*!
@@ -44,11 +44,11 @@ struct mod_mhu_device_config {
};
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_MHU_H */
diff --git a/module/mhu2/include/mod_mhu2.h b/module/mhu2/include/mod_mhu2.h
index 718b1174..15329c3e 100644
--- a/module/mhu2/include/mod_mhu2.h
+++ b/module/mhu2/include/mod_mhu2.h
@@ -17,12 +17,12 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
* \defgroup GroupMHUv2 Message Handling Unit (MHU) v2 Driver
- * @{
+ * \{
*/
/*!
@@ -57,11 +57,11 @@ struct mod_mhu2_channel_config {
};
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_MHU2_H */
diff --git a/module/msys_rom/include/mod_msys_rom.h b/module/msys_rom/include/mod_msys_rom.h
index ce682698..f5f402b9 100644
--- a/module/msys_rom/include/mod_msys_rom.h
+++ b/module/msys_rom/include/mod_msys_rom.h
@@ -21,7 +21,7 @@
/*!
* \ingroup GroupMSYSModule
* \defgroup GroupMSYSROM ROM Support
- * @{
+ * \{
*/
/*!
@@ -58,11 +58,11 @@ static const fwk_id_t mod_msys_rom_notification_id_systop =
MOD_MSYS_ROM_NOTIFICATION_IDX_POWER_SYSTOP);
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_MSYS_ROM_H */
diff --git a/module/pcid/include/mod_pcid.h b/module/pcid/include/mod_pcid.h
index dd74a086..993fd525 100644
--- a/module/pcid/include/mod_pcid.h
+++ b/module/pcid/include/mod_pcid.h
@@ -15,7 +15,7 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
@@ -23,7 +23,7 @@
*
* \brief Module used to check the peripheral and component IDs.
*
- * @{
+ * \{
*/
/*!
@@ -61,11 +61,11 @@ bool mod_pcid_check_registers(const struct mod_pcid_registers *registers,
const struct mod_pcid_registers *expected);
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_PCID_H */
diff --git a/module/pik_clock/include/mod_pik_clock.h b/module/pik_clock/include/mod_pik_clock.h
index 7bd92867..80db4aa7 100644
--- a/module/pik_clock/include/mod_pik_clock.h
+++ b/module/pik_clock/include/mod_pik_clock.h
@@ -15,7 +15,7 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
@@ -23,7 +23,7 @@
*
* \details A driver for clock devices that are part of a PIK.
*
- * @{
+ * \{
*/
/*!
@@ -280,11 +280,11 @@ struct mod_pik_clock_dev_config {
};
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_PIK_CLOCK_H */
diff --git a/module/power_domain/include/mod_power_domain.h b/module/power_domain/include/mod_power_domain.h
index b725aa37..2d38f8a7 100644
--- a/module/power_domain/include/mod_power_domain.h
+++ b/module/power_domain/include/mod_power_domain.h
@@ -22,7 +22,7 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
@@ -31,7 +31,7 @@
* \details Support for querying and setting the power state of power domains
* such as CPU, cluster and GPU power domains.
*
- * @{
+ * \{
*/
/*!
@@ -886,11 +886,11 @@ static const fwk_id_t mod_pd_public_event_id_get_state =
*/
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_POWER_DOMAIN_H */
diff --git a/module/power_domain/include/power_domain_utils.h b/module/power_domain/include/power_domain_utils.h
index a21603ed..e8289106 100644
--- a/module/power_domain/include/power_domain_utils.h
+++ b/module/power_domain/include/power_domain_utils.h
@@ -13,7 +13,7 @@
/*!
* \addtogroup GroupPowerDomain
- * @{
+ * \{
*/
#include <fwk_element.h>
@@ -55,7 +55,7 @@ const struct fwk_element *create_power_domain_element_table(
size_t static_table_size);
/*!
- * @}
+ * \}
*/
#endif /* POWER_DOMAIN_UTILS_H */
diff --git a/module/ppu_v0/include/mod_ppu_v0.h b/module/ppu_v0/include/mod_ppu_v0.h
index 441881a5..c159c637 100644
--- a/module/ppu_v0/include/mod_ppu_v0.h
+++ b/module/ppu_v0/include/mod_ppu_v0.h
@@ -18,12 +18,12 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
* \defgroup GroupModulePPUv0 PPUv0 Driver
- * @{
+ * \{
*/
/*!
@@ -80,11 +80,11 @@ struct mod_ppu_v0_pd_config {
};
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_PPU_V0_H */
diff --git a/module/ppu_v0/src/ppu_v0.h b/module/ppu_v0/src/ppu_v0.h
index 5b66ce5e..a89b2f84 100644
--- a/module/ppu_v0/src/ppu_v0.h
+++ b/module/ppu_v0/src/ppu_v0.h
@@ -10,7 +10,7 @@
/*!
* \cond
- * @{
+ * \{
*/
#include <mod_timer.h>
@@ -153,7 +153,7 @@ int ppu_v0_get_power_mode(struct ppu_v0_reg *ppu, enum ppu_v0_mode *mode);
/*!
* \endcond
- * @}
+ * \}
*/
#endif /* PPU_V0_H */
diff --git a/module/ppu_v1/include/mod_ppu_v1.h b/module/ppu_v1/include/mod_ppu_v1.h
index f968a602..8852fb86 100644
--- a/module/ppu_v1/include/mod_ppu_v1.h
+++ b/module/ppu_v1/include/mod_ppu_v1.h
@@ -21,12 +21,12 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
* \defgroup GroupModulePPUv1 PPUv1 Driver
- * @{
+ * \{
*/
/*!
@@ -181,11 +181,11 @@ struct ppu_v1_boot_api {
};
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_PPU_V1_H */
diff --git a/module/ppu_v1/src/ppu_v1.h b/module/ppu_v1/src/ppu_v1.h
index f380471f..5da0c5a3 100644
--- a/module/ppu_v1/src/ppu_v1.h
+++ b/module/ppu_v1/src/ppu_v1.h
@@ -10,7 +10,7 @@
/*!
* \cond
- * @{
+ * \{
*/
#include <mod_timer.h>
@@ -476,7 +476,7 @@ unsigned int ppu_v1_get_arch_id(struct ppu_v1_reg *ppu);
/*!
* \endcond
- * @}
+ * \}
*/
#endif /* PPU_V1_H */
diff --git a/module/reg_sensor/include/mod_reg_sensor.h b/module/reg_sensor/include/mod_reg_sensor.h
index 26f83076..86c89f1a 100644
--- a/module/reg_sensor/include/mod_reg_sensor.h
+++ b/module/reg_sensor/include/mod_reg_sensor.h
@@ -14,14 +14,14 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
* \defgroup GroupModuleRegSensor Register Sensor Driver
*
* \brief Driver for simple, register-based sensors.
- * @{
+ * \{
*/
/*! \brief Element configuration */
@@ -34,11 +34,11 @@ struct mod_reg_sensor_dev_config {
};
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_REG_SENSOR_H */
diff --git a/module/scmi/include/internal/scmi.h b/module/scmi/include/internal/scmi.h
index 49586910..0b036171 100644
--- a/module/scmi/include/internal/scmi.h
+++ b/module/scmi/include/internal/scmi.h
@@ -16,7 +16,7 @@
/*!
* \defgroup GroupSCMI System Control & Management Interface (SCMI)
- * @{
+ * \{
*/
/*!
@@ -108,7 +108,7 @@ struct scmi_protocol_message_attributes_p2a {
};
/*!
- * @}
+ * \}
*/
#endif /* INTERNAL_SCMI_H */
diff --git a/module/scmi/include/mod_scmi.h b/module/scmi/include/mod_scmi.h
index 39153824..a2cd2d9f 100644
--- a/module/scmi/include/mod_scmi.h
+++ b/module/scmi/include/mod_scmi.h
@@ -23,12 +23,12 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
* \defgroup GroupSCMI System Control & Management Interface (SCMI)
- * @{
+ * \{
*/
/*!
@@ -603,11 +603,11 @@ static const fwk_id_t mod_scmi_notification_id_initialized =
MOD_SCMI_NOTIFICATION_IDX_INITIALIZED);
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_SCMI_H */
diff --git a/module/scmi/include/mod_scmi_std.h b/module/scmi/include/mod_scmi_std.h
index 66bd5479..7f1ce067 100644
--- a/module/scmi/include/mod_scmi_std.h
+++ b/module/scmi/include/mod_scmi_std.h
@@ -13,12 +13,12 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
* \defgroup GroupSCMI System Control & Management Interface (SCMI)
- * @{
+ * \{
*/
/*!
@@ -204,11 +204,11 @@ enum scmi_reset_domain_response_id {
};
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_SCMI_STD_H */
diff --git a/module/scmi_perf/include/mod_scmi_perf.h b/module/scmi_perf/include/mod_scmi_perf.h
index 3b9eb302..617c02db 100644
--- a/module/scmi_perf/include/mod_scmi_perf.h
+++ b/module/scmi_perf/include/mod_scmi_perf.h
@@ -19,12 +19,12 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
* \defgroup GroupSCMI_PERF SCMI Performance Domain Management Protocol
- * @{
+ * \{
*/
/*!
@@ -232,15 +232,15 @@ int scmi_perf_limits_set_policy(
fwk_id_t domain_id);
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* SCP_SCMI_PERF_H */
diff --git a/module/scmi_power_domain/include/internal/scmi_power_domain.h b/module/scmi_power_domain/include/internal/scmi_power_domain.h
index ce7f629f..2996004b 100644
--- a/module/scmi_power_domain/include/internal/scmi_power_domain.h
+++ b/module/scmi_power_domain/include/internal/scmi_power_domain.h
@@ -15,12 +15,12 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
* \defgroup GroupSCMI_PERF SCMI Power Domain Management Protocol
- * @{
+ * \{
*/
#define SCMI_PROTOCOL_VERSION_POWER_DOMAIN UINT32_C(0x10000)
@@ -120,11 +120,11 @@ struct __attribute((packed)) scmi_pd_power_state_notification_message_p2a {
};
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* INTERNAL_SCMI_POWER_DOMAIN_H */
diff --git a/module/scmi_sensor/include/internal/scmi_sensor.h b/module/scmi_sensor/include/internal/scmi_sensor.h
index aba20deb..aadc6aa0 100644
--- a/module/scmi_sensor/include/internal/scmi_sensor.h
+++ b/module/scmi_sensor/include/internal/scmi_sensor.h
@@ -15,12 +15,12 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
* \defgroup GroupSCMI_PERF SCMI Sensor Management Protocol
- * @{
+ * \{
*/
#define SCMI_PROTOCOL_VERSION_SENSOR UINT32_C(0x10000)
@@ -151,11 +151,11 @@ enum scmi_sensor_api_idx {
};
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* INTERNAL_SCMI_SENSOR_H */
diff --git a/module/scmi_system_power/include/mod_scmi_system_power.h b/module/scmi_system_power/include/mod_scmi_system_power.h
index 7a7016ce..45893efd 100644
--- a/module/scmi_system_power/include/mod_scmi_system_power.h
+++ b/module/scmi_system_power/include/mod_scmi_system_power.h
@@ -14,12 +14,12 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
* \defgroup GroupSCMI_SYS SCMI System Power Management Protocol
- * @{
+ * \{
*/
/*!
@@ -137,15 +137,15 @@ int scmi_sys_power_state_set_policy(
bool graceful);
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_SCMI_SYSTEM_POWER_H */
diff --git a/module/sds/include/mod_sds.h b/module/sds/include/mod_sds.h
index 84aa30f5..77b23835 100644
--- a/module/sds/include/mod_sds.h
+++ b/module/sds/include/mod_sds.h
@@ -18,7 +18,7 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
@@ -27,7 +27,7 @@
* \details Provides a framework for the structured storage of data that is
* shared between the SCP Firmware and application processor firmware.
*
- * @{
+ * \{
*/
/*
@@ -227,11 +227,11 @@ struct mod_sds_api {
};
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_SDS_H */
diff --git a/module/sensor/include/mod_sensor.h b/module/sensor/include/mod_sensor.h
index 94ec3d70..ab6f13bc 100644
--- a/module/sensor/include/mod_sensor.h
+++ b/module/sensor/include/mod_sensor.h
@@ -16,7 +16,7 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
@@ -26,7 +26,7 @@
*
* \details Module for interfacing with and reading various hardware sensors.
*
- * @{
+ * \{
*/
/*!
@@ -324,11 +324,11 @@ static const fwk_id_t mod_sensor_event_id_read_request =
FWK_ID_EVENT_INIT(FWK_MODULE_IDX_SENSOR, MOD_SENSOR_EVENT_IDX_READ_REQUEST);
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_SENSOR_H */
diff --git a/module/sensor/src/sensor.h b/module/sensor/src/sensor.h
index 1bd31217..9ac4e89c 100644
--- a/module/sensor/src/sensor.h
+++ b/module/sensor/src/sensor.h
@@ -16,7 +16,7 @@
/*!
* \cond
- * @{
+ * \{
*/
/*
@@ -47,7 +47,7 @@ static const fwk_id_t mod_sensor_event_id_read_complete =
/*!
* \endcond
- * @}
+ * \}
*/
#endif /* SENSOR_H */
diff --git a/module/sid/include/mod_sid.h b/module/sid/include/mod_sid.h
index cfa2779a..44e49761 100644
--- a/module/sid/include/mod_sid.h
+++ b/module/sid/include/mod_sid.h
@@ -18,7 +18,7 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
@@ -27,7 +27,7 @@
* \brief Module used to interface with the SID register set.
*
* \details This module uses the SID register set to get information about the
- * subsystem that the firmware is running on. @{
+ * subsystem that the firmware is running on. \{
*/
/*!
@@ -115,11 +115,11 @@ enum mod_sid_api_idx {
};
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_SID_H */
diff --git a/module/smt/include/mod_smt.h b/module/smt/include/mod_smt.h
index 9850a4fd..e3655982 100644
--- a/module/smt/include/mod_smt.h
+++ b/module/smt/include/mod_smt.h
@@ -20,7 +20,7 @@
* \details These policies define attributes that affect how the channel is
* treated by the SMT component.
*
- * @{
+ * \{
*/
/*! No policies */
@@ -33,7 +33,7 @@
#define MOD_SMT_POLICY_INIT_MAILBOX ((uint32_t)(1 << 1))
/*!
- * @}
+ * \}
*/
/*!
diff --git a/module/system_info/include/mod_system_info.h b/module/system_info/include/mod_system_info.h
index 02889e78..03750874 100644
--- a/module/system_info/include/mod_system_info.h
+++ b/module/system_info/include/mod_system_info.h
@@ -15,7 +15,7 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
@@ -28,7 +28,7 @@
* driver module to obtain a pointer to the system information data. Module
* which requires system information data then can use the api provided
* by this module to get the generic system information.
- * @{
+ * \{
*/
/*!
@@ -117,11 +117,11 @@ enum mod_system_info_api_idx {
};
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_SYSTEM_INFO_H */
diff --git a/module/system_pll/include/mod_system_pll.h b/module/system_pll/include/mod_system_pll.h
index 78bf8776..2c2645c5 100644
--- a/module/system_pll/include/mod_system_pll.h
+++ b/module/system_pll/include/mod_system_pll.h
@@ -20,7 +20,7 @@
*
* \details A driver for system PLL devices.
*
- * @{
+ * \{
*/
/*! The slowest rate at which the PLL hardware can operate. */
@@ -85,11 +85,11 @@ struct mod_system_pll_dev_config {
};
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_SYSTEM_PLL_H */
diff --git a/module/system_power/include/mod_system_power.h b/module/system_power/include/mod_system_power.h
index bac5b725..37b5e48e 100644
--- a/module/system_power/include/mod_system_power.h
+++ b/module/system_power/include/mod_system_power.h
@@ -23,7 +23,7 @@
* \ingroup GroupModules Modules
* \defgroup GroupSystemPower System Power Support
*
- * @{
+ * \{
*/
/*! Additional system_power power states */
@@ -164,7 +164,7 @@ static const fwk_id_t mod_system_power_api_id_pd_driver_input =
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_SYSTEM_POWER_H */
diff --git a/module/timer/include/mod_timer.h b/module/timer/include/mod_timer.h
index daa1282b..92d03249 100644
--- a/module/timer/include/mod_timer.h
+++ b/module/timer/include/mod_timer.h
@@ -19,7 +19,7 @@
/*!
* \addtogroup GroupModules Modules
- * @{
+ * \{
*/
/*!
@@ -30,7 +30,7 @@
* \details Provides functionality for setting timer events, tracking elapsed
* time, and synchronously delaying execution.
*
- * @{
+ * \{
*/
/*!
@@ -310,11 +310,11 @@ struct mod_timer_alarm_api {
};
/*!
- * @}
+ * \}
*/
/*!
- * @}
+ * \}
*/
#endif /* MOD_TIMER_H */