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 /module/i2c | |
| 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 'module/i2c')
| -rw-r--r-- | module/i2c/include/mod_i2c.h | 8 |
1 files changed, 4 insertions, 4 deletions
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 */ |