mirror of
https://github.com/espressif/esp-nimble.git
synced 2026-09-17 06:29:54 +00:00
host/hs_stop: add doxygen comments for the header file
Add missing structure members documentation.
This commit is contained in:
committed by
Szymon Janc
parent
b521e22267
commit
dd2083a549
@@ -20,6 +20,13 @@
|
||||
#ifndef H_BLE_HS_STOP_
|
||||
#define H_BLE_HS_STOP_
|
||||
|
||||
/**
|
||||
* @brief Bluetooth Host Stop API
|
||||
* @defgroup bt_hs_stop Bluetooth Host Stop
|
||||
* @ingroup bt_host
|
||||
* @{
|
||||
*/
|
||||
|
||||
/** @typedef ble_hs_stop_fn
|
||||
* @brief Callback function; reports the result of a host stop procedure.
|
||||
*
|
||||
@@ -38,8 +45,13 @@ typedef void ble_hs_stop_fn(int status, void *arg);
|
||||
* This should be used as an opaque structure and not modified manually.
|
||||
*/
|
||||
struct ble_hs_stop_listener {
|
||||
/** The callback function to be called when the stop procedure completes. */
|
||||
ble_hs_stop_fn *fn;
|
||||
|
||||
/** An optional argument to be passed to the callback function. */
|
||||
void *arg;
|
||||
|
||||
/** Singly-linked list entry. */
|
||||
SLIST_ENTRY(ble_hs_stop_listener) link;
|
||||
};
|
||||
|
||||
@@ -67,4 +79,8 @@ struct ble_hs_stop_listener {
|
||||
int ble_hs_stop(struct ble_hs_stop_listener *listener,
|
||||
ble_hs_stop_fn *fn, void *arg);
|
||||
|
||||
/**
|
||||
* @}
|
||||
*/
|
||||
|
||||
#endif
|
||||
|
||||
Reference in New Issue
Block a user