Skip to content

Commit 0007fe9

Browse files
committed
lib: db_discovery: fix file doxygen
Signed-off-by: Asil Zogby <[email protected]>
1 parent 475f22c commit 0007fe9

File tree

1 file changed

+4
-27
lines changed

1 file changed

+4
-27
lines changed

include/bm/bluetooth/ble_db_discovery.h

Lines changed: 4 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,35 +3,12 @@
33
*
44
* SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
55
*/
6-
/**
7-
* @file
6+
7+
/** @file
88
*
9-
* @defgroup ble_db_discovery Database Discovery
9+
* @defgroup ble_db_discovery BLE Nordic database discovery library
1010
* @{
11-
* @ingroup ble_sdk_lib
12-
*
13-
* @brief Database discovery module.
14-
*
15-
* @details This module contains the APIs and types exposed by the DB Discovery module. These APIs
16-
* and types can be used by the application to perform discovery of a service and its
17-
* characteristics at the peer server. This module can also be used to discover the
18-
* desired services in multiple remote devices.
19-
*
20-
* @warning The maximum number of characteristics per service that can be discovered by this module
21-
* is determined by the number of characteristics in the service structure defined in
22-
* db_disc_config.h. If the peer has more than the supported number of characteristics,
23-
* then the first found will be discovered and any further characteristics will be ignored. Only the
24-
* following descriptors will be searched for at the peer: Client Characteristic
25-
* Configuration, Characteristic Extended Properties, Characteristic User Description, and Report
26-
* Reference.
27-
*
28-
* @note Presently only one instance of a Primary Service can be discovered by this module. If
29-
* there are multiple instances of the service at the peer, only the first instance
30-
* of it at the peer is fetched and returned to the application.
31-
*
32-
* @note The application must propagate BLE stack events to this module by calling
33-
* ble_db_discovery_on_ble_evt().
34-
*
11+
* @brief Library for discovery of a service and its characteristics at the peer server.
3512
*/
3613

3714
#include <stdint.h>

0 commit comments

Comments
 (0)