Copy edit GattCallbackParamTypes.h

Copy edit for active voice.

Author: Amanda Butler

features/FEATURE_BLE/ble/GattCallbackParamTypes.h

@@ -31,13 +31,13 @@
  * whether the GattServer has received a write request or a GattClient has
  * received a write response.
  *
- * @important The fields offset, len and data are only populated by the
- * GattServer when it has received a write request. Those fields shall not be
- * used by callbacks attached to the GattClient.
+ * @important 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 fields status and error_code are only populated by the
- * GattClient when it has received a write response. Those fields shall not be
- * used by callbacks attached to the GattServer.
+ * @important 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.
  */
 struct GattWriteCallbackParams {
     /**
@@ -104,7 +104,7 @@ struct GattWriteCallbackParams {
         uint16_t offset;
 
         /**
-         * Status of the GattClient Write operation
+         * Status of the GattClient Write operation.
          *
          * @important Reserved for GattClient registered callbacks.
          */
@@ -144,9 +144,9 @@ struct GattWriteCallbackParams {
  * whether the GattServer has received a read request or a GattClient has
  * received a read response.
  *
- * @important The fields status and error_code are only populated by the
- * GattClient when it has received a read response. Those fields shall not be
- * used by callbacks attached to the GattServer.
+ * @important 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.
  */
 struct GattReadCallbackParams {
     /**
@@ -166,7 +166,7 @@ struct GattReadCallbackParams {
 
     union {
         /**
-         * Length in bytes of the data read .
+         * Length in bytes of the data read.
          */
         uint16_t len;
 
@@ -175,8 +175,8 @@ struct GattReadCallbackParams {
          *
          * @important Reserved for GattClient registered callbacks.
          *
-         * @important set if status is not equal to BLE_ERROR_NONE otherwise
-         * this field shall be interpreted as len.
+         * @important set if status is not equal to BLE_ERROR_NONE; otherwise,
+         * this field is interpreted as len.
          */
         uint8_t error_code;
     };
@@ -189,7 +189,7 @@ struct GattReadCallbackParams {
     const uint8_t *data;
 
     /**
-     * Status of the GattClient Read operation
+     * Status of the GattClient Read operation.
      *
      * @important Reserved for GattClient registered callbacks.
      */
@@ -299,9 +299,9 @@ struct GattWriteAuthCallbackParams {
     /**
      * Authorization result.
      *
-     * This parameter shall be set by the callback. If the value is set to
-     * AUTH_CALLBACK_REPLY_SUCCESS then the write request will be accepted
-     * otherwise an error code will be returned to the peer client.
+     * The callback sets this parameter. If the value is set to
+     * AUTH_CALLBACK_REPLY_SUCCESS, then the write request is accepted;
+     * otherwise, an error code is returned to the peer client.
      */
     GattAuthCallbackReply_t authorizationReply;
 };
@@ -338,17 +338,17 @@ struct GattReadAuthCallbackParams {
     /**
      * Authorization result.
      *
-     * This parameter shall be set by the callback. If the value is set to
-     * AUTH_CALLBACK_REPLY_SUCCESS then the read request will be accepted
-     * otherwise an error code will be returned to the peer client.
+     * The callback sets this parameter. If the value is set to
+     * AUTH_CALLBACK_REPLY_SUCCESS, then the read request is accepted;
+     * otherwise, an error code is returned to the peer client.
      */
     GattAuthCallbackReply_t authorizationReply;
 };
 
 /**
  * Handle Value Notification/Indication event.
  *
- * This type of event is generated by the GattClient upon the reception of a
+ * The GattClient generates this type of event upon the reception of a
  * Handle Value Notification or Indication.
  *
  * The event is passed to callbacks registered by GattClient::onHVX().