diff options
| author | Chris Kay <chris.kay@arm.com> | 2020-09-28 12:20:35 +0100 |
|---|---|---|
| committer | jimqui01 <54316584+jimqui01@users.noreply.github.com> | 2020-10-02 14:19:09 +0100 |
| commit | 3361c3269a4c6b053a39766c945a8be1611ce5c7 (patch) | |
| tree | 418486f631b259021af500475b2fb6e773ba990a /product/sgm775 | |
| parent | 8d2dafa877386947f8ffadff97767114a55efe62 (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 'product/sgm775')
3 files changed, 18 insertions, 18 deletions
diff --git a/product/sgm775/module/sgm775_ddr_phy500/include/mod_sgm775_ddr_phy500.h b/product/sgm775/module/sgm775_ddr_phy500/include/mod_sgm775_ddr_phy500.h index 14fb9ffa..c17c365b 100644 --- a/product/sgm775/module/sgm775_ddr_phy500/include/mod_sgm775_ddr_phy500.h +++ b/product/sgm775/module/sgm775_ddr_phy500/include/mod_sgm775_ddr_phy500.h @@ -17,12 +17,12 @@ /*! * \addtogroup GroupSGM775Module SGM775 Product Modules - * @{ + * \{ */ /*! * \addtogroup GroupSGM775_DDR SGM775 DDR PHY500 Driver - * @{ + * \{ */ /*! @@ -31,7 +31,7 @@ struct mod_sgm775_ddr_phy500_reg { /*! * \cond - * @{ + * \{ */ FWK_RW uint32_t INIT_COMPLETE; FWK_RW uint32_t MEMORY_WIDTH; @@ -59,7 +59,7 @@ struct mod_sgm775_ddr_phy500_reg { FWK_RW uint32_t T_CTRL_UPD_MIN; /*! * \endcond - * @} + * \} */ }; @@ -72,11 +72,11 @@ struct mod_sgm775_ddr_phy500_element_config { }; /*! - * @} + * \} */ /*! - * @} + * \} */ #endif /* MOD_SGM775_DDR_PHY500_H */ diff --git a/product/sgm775/module/sgm775_dmc500/include/mod_sgm775_dmc500.h b/product/sgm775/module/sgm775_dmc500/include/mod_sgm775_dmc500.h index 19bd89ed..c7912adf 100644 --- a/product/sgm775/module/sgm775_dmc500/include/mod_sgm775_dmc500.h +++ b/product/sgm775/module/sgm775_dmc500/include/mod_sgm775_dmc500.h @@ -21,12 +21,12 @@ /*! * \addtogroup GroupSGM775Module SGM775 Product Modules - * @{ + * \{ */ /*! * \addtogroup GroupSGM775_DMC SGM775 DMC-500 Driver - * @{ + * \{ */ /*! @@ -35,7 +35,7 @@ struct mod_sgm775_dmc500_reg { /*! * \cond - * @{ + * \{ */ FWK_R uint32_t SI0_SI_STATUS; FWK_R uint32_t SI0_SI_INTERRUPT_STATUS; @@ -404,9 +404,9 @@ struct mod_sgm775_dmc500_reg { FWK_R uint32_t COMPONENT_ID_2; FWK_R uint32_t COMPONENT_ID_3; /*! - * \endcond - * @} - */ + * \endcond + * \} + */ }; /*! @@ -463,11 +463,11 @@ struct mod_sgm775_dmc500_module_config { }; /*! - * @} + * \} */ /*! - * @} + * \} */ #endif /* MOD_SGM775_DMC500_H */ diff --git a/product/sgm775/module/sgm775_system/include/mod_sgm775_system.h b/product/sgm775/module/sgm775_system/include/mod_sgm775_system.h index 82fbf627..6ade2bf9 100644 --- a/product/sgm775/module/sgm775_system/include/mod_sgm775_system.h +++ b/product/sgm775/module/sgm775_system/include/mod_sgm775_system.h @@ -13,13 +13,13 @@ /*! * \addtogroup GroupSGM775Module SGM775 Product Modules - * @{ + * \{ */ /*! * \defgroup GroupSGM775System SGM775 System Support * - * @{ + * \{ */ /*! @@ -34,11 +34,11 @@ enum mod_sgm775_system_api_idx { }; /*! - * @} + * \} */ /*! - * @} + * \} */ #endif /* MOD_SGM775_SYSTEM_H */ |