summaryrefslogtreecommitdiffstats
path: root/api/tinyb
diff options
context:
space:
mode:
authorSven Gothel <[email protected]>2020-05-18 06:00:17 +0200
committerSven Gothel <[email protected]>2020-05-18 06:00:17 +0200
commit82db617ba6d9d0be49c851320cffdb8b1d112b93 (patch)
tree181066ed0cfc053c8aaa5a3bdd0e4601f2f0706e /api/tinyb
parent20bed4dae489ec3c1821eaed2d7fad9dc6f8f715 (diff)
Fix general Doxygen Documentation
- Ensure C++ namespace gets properly documented -- Added tinyb namespace doc in BluetoothAdapter.hpp (first file) -- Added direct_bt namespace doc in ATTPDUTypes.hpp (first file) Showing hierarchy and hinting to details and coverage. - Fix CMakeList for doc target and some doxygen config finetuning
Diffstat (limited to 'api/tinyb')
-rw-r--r--api/tinyb/BluetoothAdapter.hpp21
1 files changed, 16 insertions, 5 deletions
diff --git a/api/tinyb/BluetoothAdapter.hpp b/api/tinyb/BluetoothAdapter.hpp
index ef9981de..2f5b2d9d 100644
--- a/api/tinyb/BluetoothAdapter.hpp
+++ b/api/tinyb/BluetoothAdapter.hpp
@@ -35,16 +35,24 @@ struct _Adapter1;
typedef struct _Adapter1 Adapter1;
/**
+ * TinyB exposes the BLE GATT API for C++, Java and other languages, using BlueZ
+ * over DBus and alternative implementations.
+ *
+ * TinyB aims to create clean, modern and easy to use Bluetooth LE API.
+ */
+namespace tinyb {
+
+/**
* Provides access to Bluetooth adapters. Follows the BlueZ adapter API
* available at: http://git.kernel.org/cgit/bluetooth/bluez.git/tree/doc/adapter-api.txt
*/
-class tinyb::BluetoothAdapter: public BluetoothObject
+class BluetoothAdapter: public BluetoothObject
{
-friend class tinyb::BluetoothManager;
-friend class tinyb::BluetoothEventManager;
-friend class tinyb::BluetoothDevice;
-friend class tinyb::BluetoothNotificationHandler;
+friend class BluetoothManager;
+friend class BluetoothEventManager;
+friend class BluetoothDevice;
+friend class BluetoothNotificationHandler;
private:
Adapter1 *object;
@@ -325,3 +333,6 @@ public:
const std::string &arg_address, const std::string &arg_address_type);
};
+
+} /* namespace tinyb */
+