diff options
author | Sven Gothel <[email protected]> | 2020-09-03 15:39:06 +0200 |
---|---|---|
committer | Sven Gothel <[email protected]> | 2020-09-03 15:39:06 +0200 |
commit | d4a48bb4e01810f274af3d5b20c79d9fba6759c6 (patch) | |
tree | 9511f1ef52156c1d36ab41b9f25f0d36f0009a50 /api | |
parent | f01c844052258edee87b165055349152622f80f6 (diff) |
Fixing Example crossreference and Menu item
The \example tag referring to the example code file must be added to the actual API (header) files.
Diffstat (limited to 'api')
-rw-r--r-- | api/direct_bt/ATTPDUTypes.hpp | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/api/direct_bt/ATTPDUTypes.hpp b/api/direct_bt/ATTPDUTypes.hpp index ffabec20..e58474df 100644 --- a/api/direct_bt/ATTPDUTypes.hpp +++ b/api/direct_bt/ATTPDUTypes.hpp @@ -1462,5 +1462,36 @@ namespace direct_bt { }; } +/** \example dbt_scanner10.cpp + * This C++ scanner example uses the Direct-BT fully event driven workflow + * and adds multithreading, i.e. one thread processes each found device found + * as notified via the event listener. + * <p> + * This example represents the recommended utilization of Direct-BT. + * </p> + */ + + /** \example dbt_scanner00.cpp + * This C++ direct_bt scanner example is a TinyB backward compatible and not fully event driven. + * It uses a more simple high-level approach via semantic GATT types (Service, Characteristic, ..) + * without bothering with fine implementation details of GATTHandler. + * <p> + * For a more technical and low-level approach see dbt_scanner01.cpp! + * </p> + * <p> + * This example does not represent the recommended utilization of Direct-BT. + * </p> + */ + + /** \example dbt_scanner01.cpp + * This C++ direct_bt scanner example is a TinyB backward compatible and not fully event driven. + * It uses a more fine grained control via GATTHandler. + * <p> + * For a more user convenient and readable approach see dbt_scanner00.cpp or dbt_scanner10.cpp! + * </p> + * <p> + * This example does not represent the recommended utilization of Direct-BT. + * </p> + */ #endif /* ATT_PDU_TYPES_HPP_ */ |