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>

10 files changed, 46 insertions, 46 deletions

diff --git a/product/morello/module/cmn_skeena/include/mod_cmn_skeena.h b/product/morello/module/cmn_skeena/include/mod_cmn_skeena.h
index dbfd5431..94960b84 100644
--- a/product/morello/module/cmn_skeena/include/mod_cmn_skeena.h
+++ b/product/morello/module/cmn_skeena/include/mod_cmn_skeena.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 CMN_SKEENA interconnect
- * @{
+ * \{
  */
 
 /*!
@@ -303,11 +303,11 @@ struct mod_cmn_skeena_ccix_config_api {
 };
 
 /*!
- * @}
+ * \}
  */
 
 /*!
- * @}
+ * \}
  */
 
 #endif /* MOD_CMN_SKEENA_H */
diff --git a/product/morello/module/dmc_bing/include/mod_dmc_bing.h b/product/morello/module/dmc_bing/include/mod_dmc_bing.h
index a87dd0cc..75e7d3d2 100644
--- a/product/morello/module/dmc_bing/include/mod_dmc_bing.h
+++ b/product/morello/module/dmc_bing/include/mod_dmc_bing.h
@@ -19,7 +19,7 @@
 
 /*!
  * \addtogroup GroupModules Modules
- * @{
+ * \{
  */
 
 /*!
@@ -31,7 +31,7 @@
  *
  * \sa
  * https://developer.arm.com/docs/100568/latest/programmers-model/register-summary
- * @{
+ * \{
  */
 
 /*!
@@ -45,7 +45,7 @@
 struct mod_dmc_bing_access_address_next {
     /*!
      * \cond
-     * @{
+     * \{
      */
     FWK_RW uint32_t MIN_31_00;
     FWK_RW uint32_t MIN_43_32;
@@ -53,7 +53,7 @@ struct mod_dmc_bing_access_address_next {
     FWK_RW uint32_t MAX_43_32;
     /*!
      * \endcond
-     * @}
+     * \}
      */
 };
 
@@ -63,7 +63,7 @@ struct mod_dmc_bing_access_address_next {
 struct mod_dmc_bing_access_address_now {
     /*!
      * \cond
-     * @{
+     * \{
      */
     FWK_R uint32_t MIN_31_00;
     FWK_R uint32_t MIN_43_32;
@@ -71,7 +71,7 @@ struct mod_dmc_bing_access_address_now {
     FWK_R uint32_t MAX_43_32;
     /*!
      * \endcond
-     * @}
+     * \}
      */
 };
 
@@ -81,7 +81,7 @@ struct mod_dmc_bing_access_address_now {
 struct mod_dmc_bing_pmu_counter {
     /*!
      * \cond
-     * @{
+     * \{
      */
     FWK_RW uint32_t MASK_31_00;
     FWK_RW uint32_t MASK_63_32;
@@ -95,7 +95,7 @@ struct mod_dmc_bing_pmu_counter {
     uint32_t RESERVED2;
     /*!
      * \endcond
-     * @}
+     * \}
      */
 };
 
@@ -105,7 +105,7 @@ struct mod_dmc_bing_pmu_counter {
 struct mod_dmc_bing_reg {
     /*!
      * \cond
-     * @{
+     * \{
      */
     FWK_R uint32_t MEMC_STATUS;
     FWK_R uint32_t MEMC_CONFIG;
@@ -561,7 +561,7 @@ struct mod_dmc_bing_reg {
     FWK_R uint32_t COMPONENT_ID_3;
     /*!
      * \endcond
-     * @}
+     * \}
      */
 };
 
@@ -663,11 +663,11 @@ struct mod_dmc_bing_module_config {
 extern const struct fwk_module module_dmc_bing;
 
 /*!
- * @}
+ * \}
  */
 
 /*!
- * @}
+ * \}
  */
 
 #endif /* MOD_DMC_BING_H */
diff --git a/product/morello/module/morello_mcp_system/include/mod_morello_mcp_system.h b/product/morello/module/morello_mcp_system/include/mod_morello_mcp_system.h
index 551e945e..e8b75fbd 100644
--- a/product/morello/module/morello_mcp_system/include/mod_morello_mcp_system.h
+++ b/product/morello/module/morello_mcp_system/include/mod_morello_mcp_system.h
@@ -13,12 +13,12 @@
 
 /*!
  * \addtogroup GroupMORELLOModule MORELLO Product Modules
- * @{
+ * \{
  */
 
 /*!
  * \defgroup GroupMORELLOMCPSystem MORELLO MCP System Support
- * @{
+ * \{
  */
 
 /*!
@@ -32,11 +32,11 @@ enum mcp_system_event {
 };
 
 /*!
- * @}
+ * \}
  */
 
 /*!
- * @}
+ * \}
  */
 
 #endif /* MOD_MORELLO_MCP_SYSTEM_H */
diff --git a/product/morello/module/morello_mhu/include/mod_mhu.h b/product/morello/module/morello_mhu/include/mod_mhu.h
index 8b74e4a6..b5291d95 100644
--- a/product/morello/module/morello_mhu/include/mod_mhu.h
+++ b/product/morello/module/morello_mhu/include/mod_mhu.h
@@ -17,12 +17,12 @@
 
 /*!
  * \addtogroup GroupMORELLOModule MORELLO Product Modules
- * @{
+ * \{
  */
 
 /*!
  * \defgroup GroupMORELLOMHU MORELLO Message Handling Unit (MHU) Driver
- * @{
+ * \{
  */
 
 /*!
@@ -44,11 +44,11 @@ struct mod_mhu_device_config {
 };
 
 /*!
- * @}
+ * \}
  */
 
 /*!
- * @}
+ * \}
  */
 
 #endif /* MOD_MHU_H */
diff --git a/product/morello/module/morello_pll/include/mod_morello_pll.h b/product/morello/module/morello_pll/include/mod_morello_pll.h
index 8b520446..b601d941 100644
--- a/product/morello/module/morello_pll/include/mod_morello_pll.h
+++ b/product/morello/module/morello_pll/include/mod_morello_pll.h
@@ -14,7 +14,7 @@
 
 /*!
  * \addtogroup GroupMORELLOModule MORELLO Product Modules
- * @{
+ * \{
  */
 
 /*!
@@ -22,7 +22,7 @@
  *
  * \details A driver for PLL hardware in MORELLO product.
  *
- * @{
+ * \{
  */
 
 /*! Timeout value to wait for a PLL to lock. */
@@ -95,11 +95,11 @@ struct morello_pll_module_config {
 };
 
 /*!
- * @}
+ * \}
  */
 
 /*!
- * @}
+ * \}
  */
 
 #endif /* MOD_MORELLO_PLL_H */
diff --git a/product/morello/module/morello_rom/include/mod_morello_rom.h b/product/morello/module/morello_rom/include/mod_morello_rom.h
index 03f2692b..02c5105b 100644
--- a/product/morello/module/morello_rom/include/mod_morello_rom.h
+++ b/product/morello/module/morello_rom/include/mod_morello_rom.h
@@ -14,12 +14,12 @@
 
 /*!
  * \addtogroup GroupMORELLOModule MORELLO Product Modules
- * @{
+ * \{
  */
 
 /*!
  * \defgroup GroupMORELLORom MORELLO SCP ROM Support
- * @{
+ * \{
  */
 
 /*!
@@ -34,11 +34,11 @@ struct morello_rom_config {
 };
 
 /*!
- * @}
+ * \}
  */
 
 /*!
- * @}
+ * \}
  */
 
 #endif /* MOD_MORELLO_ROM_H */
diff --git a/product/morello/module/morello_smt/include/mod_smt.h b/product/morello/module/morello_smt/include/mod_smt.h
index d3e2de62..6b012eb9 100644
--- a/product/morello/module/morello_smt/include/mod_smt.h
+++ b/product/morello/module/morello_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/product/morello/module/morello_system/include/mod_morello_system.h b/product/morello/module/morello_system/include/mod_morello_system.h
index 1da3cb3b..507e35e8 100644
--- a/product/morello/module/morello_system/include/mod_morello_system.h
+++ b/product/morello/module/morello_system/include/mod_morello_system.h
@@ -13,12 +13,12 @@
 
 /*!
  * \addtogroup GroupMORELLOModule MORELLO Product Modules
- * @{
+ * \{
  */
 
 /*!
  * \defgroup GroupMORELLOSystem MORELLO System Support
- * @{
+ * \{
  */
 
 /*!
@@ -98,11 +98,11 @@ struct mod_morello_system_ap_memory_access_api {
 };
 
 /*!
- * @}
+ * \}
  */
 
 /*!
- * @}
+ * \}
  */
 
 #endif /* MOD_MORELLO_SYSTEM_H */
diff --git a/product/morello/module/scmi_agent/include/mod_scmi_agent.h b/product/morello/module/scmi_agent/include/mod_scmi_agent.h
index 1c243fcc..5ca4acee 100644
--- a/product/morello/module/scmi_agent/include/mod_scmi_agent.h
+++ b/product/morello/module/scmi_agent/include/mod_scmi_agent.h
@@ -17,12 +17,12 @@
 
 /*!
  * \addtogroup GroupMORELLOModule MORELLO Product Modules
- * @{
+ * \{
  */
 
 /*!
  * \defgroup GroupMORELLOScmiAgent SCMI Agent Support
- * @{
+ * \{
  */
 
 /*!
@@ -123,11 +123,11 @@ enum mod_scmi_agent_api_idx {
 };
 
 /*!
- * @}
+ * \}
  */
 
 /*!
- * @}
+ * \}
  */
 
 #endif /* MOD_SCMI_AGENT_H */
diff --git a/product/morello/module/scmi_management/include/mod_scmi_management.h b/product/morello/module/scmi_management/include/mod_scmi_management.h
index 3de45193..66ab3e3d 100644
--- a/product/morello/module/scmi_management/include/mod_scmi_management.h
+++ b/product/morello/module/scmi_management/include/mod_scmi_management.h
@@ -16,12 +16,12 @@
 
 /*!
  * \addtogroup GroupMORELLOModule MORELLO Product Modules
- * @{
+ * \{
  */
 
 /*!
  * \defgroup GroupMORELLOSCMI_MANAGEMENT SCMI Management Protocol
- * @{
+ * \{
  */
 
 /*!
@@ -67,11 +67,11 @@ struct scmi_management_chipid_info_get_p2a {
 };
 
 /*!
- * @}
+ * \}
  */
 
 /*!
- * @}
+ * \}
  */
 
 #endif /* MOD_SCMI_MANAGEMENT_H */