docs: Ensure Doxygen return values use references

At present a lot of the code-base uses `\retval` commands to framework
status codes but does not explicitly link to them. In some cases it's
necessary to explicitly link to these status codes to have Doxygen
generate a link to the relevant enumeration, and we can do this by
prefixing the name with `::`.

This style is already used in much of the code-base, so should not
conflict with any existing styles.

Change-Id: Ifc78eb425981bee3a01c791757a41a61c20e636c
Signed-off-by: Chris Kay <chris.kay@arm.com>

1 files changed, 18 insertions, 18 deletions

diff --git a/module/i2c/include/mod_i2c.h b/module/i2c/include/mod_i2c.h
index 273c456f..cd381c19 100644
--- a/module/i2c/include/mod_i2c.h
+++ b/module/i2c/include/mod_i2c.h
@@ -107,9 +107,9 @@ struct mod_i2c_driver_api {
      * \param dev_id Identifier of the I2C device
      * \param transmit_request Request information for the I2C transmission
      *
-     * \retval FWK_PENDING The request was submitted.
-     * \retval FWK_SUCCESS The request was successfully completed.
-     * \retval FWK_E_PARAM One or more parameters were invalid.
+     * \retval ::FWK_PENDING The request was submitted.
+     * \retval ::FWK_SUCCESS The request was successfully completed.
+     * \retval ::FWK_E_PARAM One or more parameters were invalid.
      * \return One of the standard framework status codes.
      */
     int (*transmit_as_master)(
@@ -126,9 +126,9 @@ struct mod_i2c_driver_api {
      * \param dev_id Identifier of the I2C device
      * \param receive_request Request information for the I2C reception
      *
-     * \retval FWK_PENDING The request was submitted.
-     * \retval FWK_SUCCESS The request was successfully completed.
-     * \retval FWK_E_PARAM One or more parameters were invalid.
+     * \retval ::FWK_PENDING The request was submitted.
+     * \retval ::FWK_SUCCESS The request was successfully completed.
+     * \retval ::FWK_E_PARAM One or more parameters were invalid.
      * \return One of the standard framework status codes.
      */
     int (*receive_as_master)(
@@ -153,10 +153,10 @@ struct mod_i2c_api {
      * \param data Pointer to the data bytes to transmit to the slave
      * \param byte_count Number of data bytes to transmit
      *
-     * \retval FWK_PENDING The request was submitted.
-     * \retval FWK_E_PARAM One or more parameters were invalid.
-     * \retval FWK_E_BUSY An I2C transaction is already on-going.
-     * \retval FWK_E_DEVICE The transmission is aborted due to a device error.
+     * \retval ::FWK_PENDING The request was submitted.
+     * \retval ::FWK_E_PARAM One or more parameters were invalid.
+     * \retval ::FWK_E_BUSY An I2C transaction is already on-going.
+     * \retval ::FWK_E_DEVICE The transmission is aborted due to a device error.
      * \return One of the standard framework status codes.
      */
     int (*transmit_as_master)(fwk_id_t dev_id, uint8_t slave_address,
@@ -176,10 +176,10 @@ struct mod_i2c_api {
      * \param data Pointer to the buffer to receive data from the slave
      * \param byte_count Number of data bytes to receive
      *
-     * \retval FWK_PENDING The request was submitted.
-     * \retval FWK_E_PARAM One or more parameters were invalid.
-     * \retval FWK_E_BUSY An I2C transaction is already on-going.
-     * \retval FWK_E_DEVICE The reception is aborted due to a device error.
+     * \retval ::FWK_PENDING The request was submitted.
+     * \retval ::FWK_E_PARAM One or more parameters were invalid.
+     * \retval ::FWK_E_BUSY An I2C transaction is already on-going.
+     * \retval ::FWK_E_DEVICE The reception is aborted due to a device error.
      * \return One of the standard framework status codes.
      */
     int (*receive_as_master)(fwk_id_t dev_id, uint8_t slave_address,
@@ -206,10 +206,10 @@ struct mod_i2c_api {
      * \param receive_byte_count Number of data bytes to receive in the second
      *      phase.
      *
-     * \retval FWK_PENDING The request was submitted.
-     * \retval FWK_E_PARAM One or more parameters were invalid.
-     * \retval FWK_E_BUSY An I2C transaction is already on-going.
-     * \retval FWK_E_DEVICE The reception is aborted due to a device error.
+     * \retval ::FWK_PENDING The request was submitted.
+     * \retval ::FWK_E_PARAM One or more parameters were invalid.
+     * \retval ::FWK_E_BUSY An I2C transaction is already on-going.
+     * \retval ::FWK_E_DEVICE The reception is aborted due to a device error.
      * \return One of the standard framework status codes.
      */
     int (*transmit_then_receive_as_master)(fwk_id_t dev_id,