mirror/btstack
1
0
Fork 0
mirror of https://github.com/bluekitchen/btstack.git synced 2025-02-23 09:41:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

docu: update header files tagging

Browse Source
This commit is contained in:
Milanka Ringwald 2021-05-28 11:36:59 +02:00
parent 4a400a05d4
commit 90f75057f9
5 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/ad_parser.h
View File

@ -36,8 +36,9 @@
*/ */
/** /**
* @title AD Data (Advertisements and EIR) Parser * @title AD Data Parser
* *
* AD Data (Advertisements and EIR) Parser
*/ */
#ifndef AD_PARSER_H #ifndef AD_PARSER_H

4
src/ble/gatt-service/hids_device.h
View File

@ -51,6 +51,8 @@
extern "C" { extern "C" {
#endif #endif
/* API_START */
/** /**
* @text Implementation of the GATT HIDS Device * @text Implementation of the GATT HIDS Device
* To use with your application, add '#import <hids.gatt>' to your .gatt file * To use with your application, add '#import <hids.gatt>' to your .gatt file
@ -99,6 +101,8 @@ void hids_device_send_boot_mouse_input_report(hci_con_handle_t con_handle, const
*/ */
void hids_device_send_boot_keyboard_input_report(hci_con_handle_t con_handle, const uint8_t * report, uint16_t report_len); void hids_device_send_boot_keyboard_input_report(hci_con_handle_t con_handle, const uint8_t * report, uint16_t report_len);
/* API_END */
#if defined __cplusplus #if defined __cplusplus
} }
#endif #endif

3
src/btstack_chipset.h
View File

@ -60,6 +60,7 @@ typedef enum {
BTSTACK_CHIPSET_NO_INIT_SCRIPT, BTSTACK_CHIPSET_NO_INIT_SCRIPT,
} btstack_chipset_result_t; } btstack_chipset_result_t;
/* API_START */
typedef struct { typedef struct {
/** /**
@ -96,6 +97,8 @@ typedef struct {
} btstack_chipset_t; } btstack_chipset_t;
/* API_END */
#if defined __cplusplus #if defined __cplusplus
} }
#endif #endif

8
src/btstack_control.h
View File

@ -36,9 +36,9 @@
*/ */
/** /**
* @title BTstack Bluetooth Hardware Control * @title Bluetooth Power Control
* *
* The API allows HCI to manage Bluetooth chipsets via direct hardware controls. * The Bluetooth Hardware Control API allows HCI to manage Bluetooth chipsets via direct hardware controls.
* *
*/ */
@ -57,6 +57,8 @@ typedef enum {
POWER_WILL_WAKE_UP POWER_WILL_WAKE_UP
} POWER_NOTIFICATION_t; } POWER_NOTIFICATION_t;
/* API_START */
typedef struct { typedef struct {
void (*init) (const void *config); void (*init) (const void *config);
int (*on) (void); // <-- turn BT module on and configure int (*on) (void); // <-- turn BT module on and configure
@ -66,6 +68,8 @@ typedef struct {
void (*register_for_power_notifications)(void (*cb)(POWER_NOTIFICATION_t event)); void (*register_for_power_notifications)(void (*cb)(POWER_NOTIFICATION_t event));
} btstack_control_t; } btstack_control_t;
/* API_END */
#if defined __cplusplus #if defined __cplusplus
} }
#endif #endif

2
src/btstack_event.h
View File

@ -36,7 +36,7 @@
*/ */
/** /**
* @title HCI Event Getter * HCI Event Getter
* *
* Note: Don't edit this file. It is generated by tool/btstack_event_generator.py * Note: Don't edit this file. It is generated by tool/btstack_event_generator.py
* *