Remove duplicate documentation comments

Author: AGlass0fMilk

connectivity/FEATURE_BLE/include/ble/gap/ChainableGapEventHandler.h

@@ -37,175 +37,54 @@ class ChainableGapEventHandler : public ble::Gap::EventHandler,
 
     virtual ~ChainableGapEventHandler() { }
 
-    /**
-     * Called when an advertising device receive a scan response.
-     *
-     * @param event Scan request event.
-     *
-     * @version: 5+.
-     *
-     * @see AdvertisingParameters::setScanRequestNotification().
-     */
     void onScanRequestReceived(const ble::ScanRequestEvent &event) override {
         execute_on_all(&ble::Gap::EventHandler::onScanRequestReceived, event);
     }
 
-    /**
-     * Called when advertising ends.
-     *
-     * Advertising ends when the process timeout or if it is stopped by the
-     * application or if the local device accepts a connection request.
-     *
-     * @param event Advertising end event.
-     *
-     * @see startAdvertising()
-     * @see stopAdvertising()
-     * @see onConnectionComplete()
-     */
     void onAdvertisingEnd(const ble::AdvertisingEndEvent &event) override {
         execute_on_all(&ble::Gap::EventHandler::onAdvertisingEnd, event);
     }
-
-    /**
-     * Called when a scanner receives an advertising or a scan response packet.
-     *
-     * @param event Advertising report.
-     *
-     * @see startScan()
-     */
+    
     void onAdvertisingReport(const ble::AdvertisingReportEvent &event) override {
         execute_on_all(&ble::Gap::EventHandler::onAdvertisingReport, event);
     }
 
-    /**
-     * Called when scan times out.
-     *
-     * @param event Associated event.
-     *
-     * @see startScan()
-     */
     void onScanTimeout(const ble::ScanTimeoutEvent &event) override {
         execute_on_all(&ble::Gap::EventHandler::onScanTimeout, event);
     }
 
-    /**
-     * Called when first advertising packet in periodic advertising is received.
-     *
-     * @param event Periodic advertising sync event.
-     *
-     * @version: 5+.
-     *
-     * @see createSync()
-     */
     void onPeriodicAdvertisingSyncEstablished(
         const ble::PeriodicAdvertisingSyncEstablishedEvent &event) override {
         execute_on_all(&ble::Gap::EventHandler::onPeriodicAdvertisingSyncEstablished, event);
     }
-
-    /**
-     * Called when a periodic advertising packet is received.
-     *
-     * @param event Periodic advertisement event.
-     *
-     * @version: 5+.
-     *
-     * @see createSync()
-     */
+    
     void onPeriodicAdvertisingReport(
         const ble::PeriodicAdvertisingReportEvent &event) override {
         execute_on_all(&ble::Gap::EventHandler::onPeriodicAdvertisingReport, event);
     }
 
-    /**
-     * Called when a periodic advertising sync has been lost.
-     *
-     * @param event Details of the event.
-     *
-     * @version: 5+.
-     *
-     * @see createSync()
-     */
     void onPeriodicAdvertisingSyncLoss(
         const ble::PeriodicAdvertisingSyncLoss &event) override {
         execute_on_all(&ble::Gap::EventHandler::onPeriodicAdvertisingSyncLoss, event);
     }
 
-    /**
-     * Called when connection attempt ends or an advertising device has been
-     * connected.
-     *
-     * @see startAdvertising()
-     * @see connect()
-     *
-     * @param event Connection event.
-     */
     void onConnectionComplete(const ble::ConnectionCompleteEvent &event) override {
         execute_on_all(&ble::Gap::EventHandler::onConnectionComplete, event);
     }
 
-    /**
-     * Called when the peer request connection parameters updates.
-     *
-     * Application must accept the update with acceptConnectionParametersUpdate()
-     * or reject it with rejectConnectionParametersUpdate().
-     *
-     * @param event The connection parameters requested by the peer.
-     *
-     * @version 4.1+.
-     *
-     * @note This event is not generated if connection parameters update
-     * is managed by the middleware.
-     *
-     * @see manageConnectionParametersUpdateRequest()
-     * @see acceptConnectionParametersUpdate()
-     * @see rejectConnectionParametersUpdate()
-     */
     void onUpdateConnectionParametersRequest(
         const ble::UpdateConnectionParametersRequestEvent &event) override {
         execute_on_all(&ble::Gap::EventHandler::onUpdateConnectionParametersRequest, event);
     }
 
-    /**
-     * Called when connection parameters have been updated.
-     *
-     * @param event The new connection parameters.
-     *
-     * @see updateConnectionParameters()
-     * @see acceptConnectionParametersUpdate()
-     */
     void onConnectionParametersUpdateComplete(
         const ble::ConnectionParametersUpdateCompleteEvent &event) override {
         execute_on_all(&ble::Gap::EventHandler::onConnectionParametersUpdateComplete, event);
     }
 
-    /**
-     * Called when a connection has been disconnected.
-     *
-     * @param event Details of the event.
-     *
-     * @see disconnect()
-     */
     void onDisconnectionComplete(const ble::DisconnectionCompleteEvent &event) override {
     }
 
-    /**
-     * Function invoked when the current transmitter and receiver PHY have
-     * been read for a given connection.
-     *
-     * @param status Status of the operation: BLE_ERROR_NONE in case of
-     * success or an appropriate error code.
-     *
-     * @param connectionHandle: The handle of the connection for which the
-     * PHYs have been read.
-     *
-     * @param txPhy PHY used by the transmitter.
-     *
-     * @param rxPhy PHY used by the receiver.
-     *
-     * @see readPhy().
-     *
-     * @version: 5+.
-     */
     void onReadPhy(
         ble_error_t status,
         ble::connection_handle_t connectionHandle,
@@ -215,31 +94,6 @@ class ChainableGapEventHandler : public ble::Gap::EventHandler,
                 connectionHandle, txPhy, rxPhy);
     }
 
-    /**
-     * Function invoked when the update process of the PHY has been completed.
-     *
-     * The process can be initiated by a call to the function setPhy, the
-     * local bluetooth subsystem or the peer.
-     *
-     * @param status Status of the operation: BLE_ERROR_NONE in case of
-     * success or an appropriate error code.
-     *
-     * @param connectionHandle: The handle of the connection on which the
-     * operation was made.
-     *
-     * @param txPhy PHY used by the transmitter.
-     *
-     * @param rxPhy PHY used by the receiver.
-     *
-     * @note Success doesn't mean the PHY has been updated it means both
-     * ends have negotiated the best PHY according to their configuration and
-     * capabilities. The PHY currently used are present in the txPhy and
-     * rxPhy parameters.
-     *
-     * @see setPhy()
-     *
-     * @version: 5+.
-     */
     void onPhyUpdateComplete(
         ble_error_t status,
         ble::connection_handle_t connectionHandle,
@@ -249,18 +103,6 @@ class ChainableGapEventHandler : public ble::Gap::EventHandler,
                 connectionHandle, txPhy, rxPhy);
     }
 
-    /**
-     * Function invoked when the connections changes the maximum number of octets
-     * that can be sent or received by the controller in a single packet. A single
-     * L2CAP packet can be fragmented across many such packets.
-     *
-     * @note This only triggers if controller supports data length extension and
-     * negotiated data length is longer than the default 23.
-     *
-     * @param connectionHandle The handle of the connection that changed the size.
-     * @param txSize Number of octets we can send on this connection in a single packet.
-     * @param rxSize Number of octets we can receive on this connection in a single packet.
-     */
     void onDataLengthChange(
         ble::connection_handle_t connectionHandle,
         uint16_t txSize,

connectivity/FEATURE_BLE/include/ble/gatt/ChainableGattServerEventHandler.h

@@ -35,94 +35,37 @@ class ChainableGattServerEventHandler : public ble::GattServer::EventHandler,
 
     ChainableGattServerEventHandler() { }
 
-    virtual ~ChainableGattServerEventHandler() { }
-
-    /**
-     * Function invoked when the connections changes the ATT_MTU which controls
-     * the maximum size of an attribute that can be read in a single L2CAP packet
-     * which might be fragmented across multiple packets.
-     *
-     * @param connectionHandle The handle of the connection that changed the size.
-     * @param attMtuSize
-     */
+    ~ChainableGattServerEventHandler() { }
+
     void onAttMtuChange(ble::connection_handle_t connectionHandle, uint16_t attMtuSize) override {
         execute_on_all(&ble::GattServer::EventHandler::onAttMtuChange,
                 connectionHandle, attMtuSize);
     }
 
-    /**
-     * Function invoked when the server has sent data to a client as
-     * part of a notification/indication.
-     *
-     * @note params has a temporary scope and should be copied by the
-     * application if needed later
-     */
     void onDataSent(const GattDataSentCallbackParams* params) override {
         execute_on_all(&ble::GattServer::EventHandler::onDataSent, params);
     }
 
-    /**
-     * Function invoked when a client writes an attribute
-     *
-     * @note params has a temporary scope and should be copied by the
-     * application if needed later
-     */
     void onDataWritten(const GattWriteCallbackParams *params) override {
         execute_on_all(&ble::GattServer::EventHandler::onDataWritten, params);
     }
 
-    /**
-     * Function invoked when a client reads an attribute
-     *
-     * @note  This functionality may not be available on all underlying stacks.
-     * Application code may work around that limitation by monitoring read
-     * requests instead of read events.
-     *
-     * @note params has a temporary scope and should be copied by the
-     * application if needed later
-     *
-     * @see GattCharacteristic::setReadAuthorizationCallback()
-     * @see isOnDataReadAvailable().
-     */
     void onDataRead(const GattReadCallbackParams *params) override {
         execute_on_all(&ble::GattServer::EventHandler::onDataRead, params);
     }
 
-    /**
-     * Function invoked when the GattServer instance is about
-     * to be shut down. This can result in a call to reset() or BLE::reset().
-     */
     void onShutdown(const GattServer *server) override {
         execute_on_all(&ble::GattServer::EventHandler::onShutdown, server);
     }
 
-    /**
-     * Function invoked when the client has subscribed to characteristic updates
-     *
-     * @note params has a temporary scope and should be copied by the
-     * application if needed later
-     */
     void onUpdatesEnabled(const GattUpdatesEnabledCallbackParams* params) override {
         execute_on_all(&ble::GattServer::EventHandler::onUpdatesEnabled, params);
     }
 
-    /**
-     * Function invoked when the client has unsubscribed to characteristic updates
-     *
-     * @note params has a temporary scope and should be copied by the
-     * application if needed later
-     */
     void onUpdatesDisabled(const GattUpdatesDisabledCallbackParams* params) override {
         execute_on_all(&ble::GattServer::EventHandler::onUpdatesDisabled, params);
     }
 
-    /**
-     * Function invoked when an ACK has been received for an
-     * indication sent to the client.
-     *
-     * @note params has a temporary scope and should be copied by the
-     * application if needed later
-     */
     void onConfirmationReceived(const GattConfirmationReceivedCallbackParams* params) override {
         execute_on_all(&ble::GattServer::EventHandler::onConfirmationReceived, params);
     }