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/rddanielxlr/module | |
| 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/rddanielxlr/module')
| -rw-r--r-- | product/rddanielxlr/module/mscp_rom/include/mod_mscp_rom.h | 8 | ||||
| -rw-r--r-- | product/rddanielxlr/module/rddanielxlr_system/include/mod_rddanielxlr_system.h | 8 |
2 files changed, 8 insertions, 8 deletions
diff --git a/product/rddanielxlr/module/mscp_rom/include/mod_mscp_rom.h b/product/rddanielxlr/module/mscp_rom/include/mod_mscp_rom.h index 9e654473..1cf3be61 100644 --- a/product/rddanielxlr/module/mscp_rom/include/mod_mscp_rom.h +++ b/product/rddanielxlr/module/mscp_rom/include/mod_mscp_rom.h @@ -12,12 +12,12 @@ /*! * \addtogroup GroupSCPModule MSCP Product Modules - * @{ + * \{ */ /*! * \defgroup GroupSCP ROM Support - * @{ + * \{ */ /*! @@ -35,11 +35,11 @@ struct mscp_rom_config { }; /*! - * @} + * \} */ /*! - * @} + * \} */ #endif /* MOD_MSCP_ROM_H */ diff --git a/product/rddanielxlr/module/rddanielxlr_system/include/mod_rddanielxlr_system.h b/product/rddanielxlr/module/rddanielxlr_system/include/mod_rddanielxlr_system.h index cc7d62e4..6fc02880 100644 --- a/product/rddanielxlr/module/rddanielxlr_system/include/mod_rddanielxlr_system.h +++ b/product/rddanielxlr/module/rddanielxlr_system/include/mod_rddanielxlr_system.h @@ -15,12 +15,12 @@ /*! * \addtogroup GroupRDDANIELXLRModule RDDANIELXLR Product Modules - * @{ + * \{ */ /*! * \defgroup GroupRDDANIELXLRSystem RDDANIELXLR System Support - * @{ + * \{ */ /*! @@ -54,11 +54,11 @@ enum mod_rddanielxlr_system_api_idx { }; /*! - * @} + * \} */ /*! - * @} + * \} */ #endif /* MOD_RDDANIELXLR_SYSTEM_H */ |