Diff: btle/btle_discovery.h

Revision:

310:4d7ccb8c2a51

Parent:

309:ef9e806a7b03

Child:

311:5d5abc30e3a8

--- a/btle/btle_discovery.h	Fri Jun 19 15:55:30 2015 +0100
+++ b/btle/btle_discovery.h	Fri Jun 19 15:55:30 2015 +0100
@@ -29,24 +29,12 @@
      * given offset. If the Characteristic or Descriptor to be read is longer
      * than ATT_MTU - 1, this function must be called multiple times with
      * appropriate offset to read the complete value.
+     *
+     * @return BLE_ERROR_NONE if a read has been initiated, else
+     *         BLE_ERROR_INVALID_STATE if some internal state about the connection is invalid, or
+     *         BLE_STACK_BUSY if some client procedure already in progress.
      */
     virtual ble_error_t read(uint16_t offset = 0) {
-        /**@brief Initiate or continue a GATT Read (Long) Characteristic or Descriptor procedure.
-         *
-         * @details This function initiates or resumes a GATT Read (Long) Characteristic or Descriptor procedure. If the Characteristic or Descriptor
-         *          to be read is longer than ATT_MTU - 1, this function must be called multiple times with appropriate offset to read the
-         *          complete value.
-         *
-         * @param[in] conn_handle The connection handle identifying the connection to perform this procedure on.
-         * @param[in] handle The handle of the attribute to be read.
-         * @param[in] offset Offset into the attribute value to be read.
-         *
-         * @retval ::NRF_SUCCESS Successfully started or resumed the Read (Long) procedure.
-         * @retval ::BLE_ERROR_INVALID_CONN_HANDLE Invalid Connection Handle.
-         * @retval ::NRF_ERROR_INVALID_STATE Invalid Connection State.
-         * @retval ::NRF_ERROR_INVALID_ADDR Invalid pointer supplied.
-         * @retval ::NRF_ERROR_BUSY Client procedure already in progress.
-         */
         // sd_ble_gattc_read()
         // SVCALL(SD_BLE_GATTC_READ, uint32_t, sd_ble_gattc_read(uint16_t conn_handle, uint16_t handle, uint16_t offset));
         return BLE_ERROR_NONE;