BLE: Fix doxygen warnings.

Replace @Important tag by @attention.

Author: pan-

features/FEATURE_BLE/ble/BLE.h

@@ -280,7 +280,7 @@ class BLE
      * function-pointer, init() can also take an <Object, member> pair as its
      * callback target.
      *
-     * @important This should be called before using anything else in the BLE
+     * @attention This should be called before using anything else in the BLE
      * API.
      */
     ble_error_t init(InitializationCompleteCallback_t completion_cb = NULL) {
@@ -321,7 +321,7 @@ class BLE
      * @return BLE_ERROR_NONE if the instance was shut down without error or the
      * appropriate error code.
      *
-     * @important init() must be called afterward to reinstate services and
+     * @attention init() must be called afterward to reinstate services and
      * GAP state. This API offers a way to repopulate the GATT database with new
      * services and characteristics.
      */

features/FEATURE_BLE/ble/BLEInstanceBase.h

@@ -46,7 +46,7 @@ class GattClient;
  * createBLEInstance(). The BLE API uses this singleton function to gain
  * access to a concrete implementation of this class defined in the vendor port.
  *
- * @important This class is part of the porting API and is not meant to be used
+ * @attention This class is part of the porting API and is not meant to be used
  * by end users of BLE API.
  *
  * @see BLE
@@ -237,7 +237,7 @@ class BLEInstanceBase
      * Process pending events present in the vendor subsystem; then, put the MCU
      * to sleep until an external source wakes it up.
      *
-     * @important This function is deprecated in the BLE class. It will be
+     * @attention This function is deprecated in the BLE class. It will be
      * removed from this interface once it is removed from BLE.
      *
      * @see BLE::waitForEvent() BLE::processEvents()
@@ -254,10 +254,10 @@ class BLEInstanceBase
 /**
  * Return the instance of the vendor implementation of BLEInstanceBase.
  *
- * @important Contrary to its name, this function does not return a new instance
+ * @attention Contrary to its name, this function does not return a new instance
  * at each call. It rather acts like an accessor to a singleton.
  *
- * @important The vendor library must provide an implementation for this function
+ * @attention The vendor library must provide an implementation for this function
  * library. Otherwise, there will be a linker error.
  */
 extern BLEInstanceBase *createBLEInstance(void);

features/FEATURE_BLE/ble/DiscoveredService.h

@@ -84,7 +84,7 @@ class DiscoveredService {
     /**
      * Construct a DiscoveredService instance.
      *
-     * @important This API is not meant to be used publicly. It is meant to be
+     * @attention This API is not meant to be used publicly. It is meant to be
      * used by internal APIs of Mbed BLE.
      */
     DiscoveredService() :
@@ -96,7 +96,7 @@ class DiscoveredService {
     /**
      * Set information about the discovered service.
      *
-     * @important This API is not meant to be used publicly. It is meant to be
+     * @attention This API is not meant to be used publicly. It is meant to be
      * used by internal APIs of Mbed BLE.
      *
      * @param[in] uuidIn The UUID of the discovered service.
@@ -118,7 +118,7 @@ class DiscoveredService {
     /**
      * Set the start and end handle of the discovered service.
      *
-     * @important This API is not meant to be used publicly. It is meant to be
+     * @attention This API is not meant to be used publicly. It is meant to be
      * used by internal APIs of Mbed BLE.
      *
      * @param[in] startHandleIn The start handle of the discovered service in
@@ -137,7 +137,7 @@ class DiscoveredService {
     /**
      * Set the long UUID of the discovered service.
      *
-     * @important This API is not meant to be used publicly. It is meant to be
+     * @attention This API is not meant to be used publicly. It is meant to be
      * used by internal APIs of Mbed BLE.
      *
      * @param[in] longUUID The bytes composing the long UUID of this discovered

features/FEATURE_BLE/ble/FunctionPointerWithContext.h

@@ -46,7 +46,7 @@
  * This class also offers a mechanism to chain other instances to it. When an
  * instance is called, all the instances being part of the chain are called.
  *
- * @important freestanding or member function adapted must accept a single
+ * @attention freestanding or member function adapted must accept a single
  * argument, and this argument is a pointer to ContextType. Adapted
  * primitives do not return anything.
  *

features/FEATURE_BLE/ble/Gap.h

@@ -347,7 +347,7 @@ class Gap {
     /**
      * Enumeration of disconnection reasons.
      *
-     * @important There might be a mismatch between the disconnection reason
+     * @attention There might be a mismatch between the disconnection reason
      * passed to disconnect() and the disconnection event generated locally
      * because the disconnection reason passed to disconnect() is the
      * disconnection reason to be transmitted to the peer.
@@ -356,7 +356,7 @@ class Gap {
         /**
          * The connection timed out.
          *
-         * @important shall not be used as a reason in disconnect().
+         * @attention shall not be used as a reason in disconnect().
          */
         CONNECTION_TIMEOUT = 0x08,
 
@@ -379,7 +379,7 @@ class Gap {
          * Indicate that the local user or the internal
          * Bluetooth subsystem terminated the connection.
          *
-         * @important shall not be used as a reason in disconnect().
+         * @attention shall not be used as a reason in disconnect().
          */
         LOCAL_HOST_TERMINATED_CONNECTION = 0x16,
 
@@ -548,7 +548,7 @@ class Gap {
      *
      * @note The BLE API does not express the broadcaster and scanner roles.
      *
-     * @important A device can fulfill different roles concurrently.
+     * @attention A device can fulfill different roles concurrently.
      */
     enum Role_t {
         /**
@@ -2271,7 +2271,7 @@ class Gap {
     /**
      * Notify all registered connection event handlers of a connection event.
      *
-     * @important This function is meant to be called from the BLE stack specific
+     * @attention This function is meant to be called from the BLE stack specific
      * implementation when a connection event occurs.
      *
      * @param[in] handle Handle of the new connection.
@@ -2312,7 +2312,7 @@ class Gap {
     /**
      * Notify all registered disconnection event handlers of a disconnection event.
      *
-     * @important This function is meant to be called from the BLE stack specific
+     * @attention This function is meant to be called from the BLE stack specific
      * implementation when a disconnection event occurs.
      *
      * @param[in] handle Handle of the terminated connection.
@@ -2334,7 +2334,7 @@ class Gap {
      * Forward a received advertising packet to all registered event handlers
      * listening for scanned packet events.
      *
-     * @important This function is meant to be called from the BLE stack specific
+     * @attention This function is meant to be called from the BLE stack specific
      * implementation when a disconnection event occurs.
      *
      * @param[in] peerAddr Address of the peer that has emitted the packet.
@@ -2367,7 +2367,7 @@ class Gap {
      * Notify the occurrence of a timeout event to all registered timeout events
      * handler.
      *
-     * @important This function is meant to be called from the BLE stack specific
+     * @attention This function is meant to be called from the BLE stack specific
      * implementation when a disconnection event occurs.
      *
      * @param[in] source Source of the timout event.

features/FEATURE_BLE/ble/GattAttribute.h

@@ -166,7 +166,7 @@ class GattAttribute {
     /**
      * Get a pointer to the current length of the attribute value.
      *
-     * @important note Do not use this function.
+     * @attention note Do not use this function.
      *
      * @return A pointer to the current length of the attribute value.
      */
@@ -178,7 +178,7 @@ class GattAttribute {
     /**
      * Set the attribute handle.
      *
-     * @important The GattServer uses this function internally.
+     * @attention The GattServer uses this function internally.
      * Application code must not use it.
      *
      * @param[in] id The new attribute handle.

features/FEATURE_BLE/ble/GattCallbackParamTypes.h

@@ -31,11 +31,11 @@
  * whether the GattServer has received a write request or a GattClient has
  * received a write response.
  *
- * @important The GattServer only populates the fields offset, len and data
+ * @attention The GattServer only populates the fields offset, len and data
  * when it has received a write request. Callbacks attached to the GattClient
  * do not use those fields.
  *
- * @important The GattClient only populates the fields status and error_code
+ * @attention The GattClient only populates the fields status and error_code
  * when it has received a write response. Callbacks attached to the GattServer
  * do not use those fields.
  */
@@ -99,14 +99,14 @@ struct GattWriteCallbackParams {
         /**
          * Offset within the attribute value to be written.
          *
-         * @important Reserved for GattServer registered callbacks.
+         * @attention Reserved for GattServer registered callbacks.
          */
         uint16_t offset;
 
         /**
          * Status of the GattClient Write operation.
          *
-         * @important Reserved for GattClient registered callbacks.
+         * @attention Reserved for GattClient registered callbacks.
          */
         ble_error_t status;
     };
@@ -115,24 +115,24 @@ struct GattWriteCallbackParams {
         /**
          * Length (in bytes) of the data to write.
          *
-         * @important Reserved for GattServer registered callbacks.
+         * @attention Reserved for GattServer registered callbacks.
          */
         uint16_t len;
 
         /**
          * Error code of the GattClient Write operation.
          *
-         * @important Reserved for GattClient registered callbacks.
+         * @attention Reserved for GattClient registered callbacks.
          */
         uint8_t error_code;
     };
 
     /**
      * Pointer to the data to write.
      *
-     * @important Data may not persist beyond the callback scope.
+     * @attention Data may not persist beyond the callback scope.
      *
-     * @important Reserved for GattServer registered callbacks.
+     * @attention Reserved for GattServer registered callbacks.
      */
     const uint8_t *data;
 };
@@ -144,7 +144,7 @@ struct GattWriteCallbackParams {
  * whether the GattServer has received a read request or a GattClient has
  * received a read response.
  *
- * @important The GattClient only populates the fields status and error_code
+ * @attention The GattClient only populates the fields status and error_code
  * when it has received a read response. Callbacks attached to the GattServer
  * do not use those fields.
  */
@@ -173,9 +173,9 @@ struct GattReadCallbackParams {
         /**
          * Error code of the GattClient read operation.
          *
-         * @important Reserved for GattClient registered callbacks.
+         * @attention Reserved for GattClient registered callbacks.
          *
-         * @important set if status is not equal to BLE_ERROR_NONE; otherwise,
+         * @attention set if status is not equal to BLE_ERROR_NONE; otherwise,
          * this field is interpreted as len.
          */
         uint8_t error_code;
@@ -184,14 +184,14 @@ struct GattReadCallbackParams {
     /**
      * Pointer to the data read.
      *
-     * @important Data may not persist beyond the callback scope.
+     * @attention Data may not persist beyond the callback scope.
      */
     const uint8_t *data;
 
     /**
      * Status of the GattClient Read operation.
      *
-     * @important Reserved for GattClient registered callbacks.
+     * @attention Reserved for GattClient registered callbacks.
      */
     ble_error_t status;
 };

features/FEATURE_BLE/ble/GattCharacteristic.h

@@ -1357,7 +1357,7 @@ class GattCharacteristic {
      * be allocated if either the notify or indicate flag in the @p props bit
      * field; the underlying BLE stack handles it.
      *
-     * @important GattCharacteristic registered in a GattServer must remain
+     * @attention GattCharacteristic registered in a GattServer must remain
      * valid for the lifetime of the GattServer.
      */
     GattCharacteristic(
@@ -1476,7 +1476,7 @@ class GattCharacteristic {
      * This function is a helper that calls the registered write handler to
      * determine the authorization reply for a write request.
      *
-     * @important This function is not meant to be called by user code.
+     * @attention This function is not meant to be called by user code.
      *
      * @param[in] params Context of the write-auth request; it contains an
      * out-parameter used as a reply.
@@ -1502,7 +1502,7 @@ class GattCharacteristic {
      * This function is a helper that calls the registered read handler to
      * determine the authorization reply for a read request.
      *
-     * @important This function is not meant to be called by user code.
+     * @attention This function is not meant to be called by user code.
      *
      * @param[in] params Context of the read-auth request; it contains an
      * out-parameter used as a reply and the handler can fill it with outgoing

features/FEATURE_BLE/ble/GattClient.h

@@ -743,7 +743,7 @@ class GattClient {
     /**
      * Forward an attribute read event to all registered handlers.
      *
-     * @important This function is meant to be called from the vendor
+     * @attention This function is meant to be called from the vendor
      * implementation when an attribute read event occurs.
      *
      * @param[in] params Attribute read event to pass to the registered handlers.
@@ -756,7 +756,7 @@ class GattClient {
     /**
      * Forward an attribute written event to all registered handlers.
      *
-     * @important This function is meant to be called from the vendor
+     * @attention This function is meant to be called from the vendor
      * implementation when an attribute written event occurs.
      *
      * @param[in] params Attribute written event to pass to the registered
@@ -771,7 +771,7 @@ class GattClient {
      * Forward a handle value notification or indication event to all registered
      * handlers.
      *
-     * @important This function is meant to be called from the vendor
+     * @attention This function is meant to be called from the vendor
      * implementation when a notification or indication event is available.
      *
      * @param[in] params Notification or Indication event to pass to the