[gnome-bluetooth] docs: document more symbols
- From: Daniele Forsi <dforsi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-bluetooth] docs: document more symbols
- Date: Mon, 6 Aug 2012 08:59:19 +0000 (UTC)
commit aa52dba18398a02eb8dee14114a0120942fa2fd1
Author: Daniele Forsi <dforsi src gnome org>
Date: Sun Aug 5 21:48:35 2012 +0200
docs: document more symbols
96% symbol docs coverage.
208 symbols documented.
4 symbols incomplete.
8 not documented.
BluetoothChooser
BluetoothChooserButton
BluetoothChooserButtonClass (<items>)
BluetoothChooserClass (<items>)
BluetoothChooserCombo
BluetoothChooserComboClass (<items>)
BluetoothClient
BluetoothClientClass (<items>)
lib/bluetooth-chooser-combo.h | 5 +++++
lib/bluetooth-client.c | 40 +++++++++++++++++++++++++++++++++++-----
lib/bluetooth-enums.h | 10 ++++++++++
3 files changed, 50 insertions(+), 5 deletions(-)
---
diff --git a/lib/bluetooth-chooser-combo.h b/lib/bluetooth-chooser-combo.h
index fa7c942..0e0c08c 100644
--- a/lib/bluetooth-chooser-combo.h
+++ b/lib/bluetooth-chooser-combo.h
@@ -33,6 +33,11 @@ G_BEGIN_DECLS
#define BLUETOOTH_GET_CHOOSER_COMBO_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), \
BLUETOOTH_TYPE_CHOOSER_COMBO, BluetoothChooserComboClass))
+/**
+* BLUETOOTH_CHOOSER_COMBO_FIRST_DEVICE:
+*
+* A convenience value used to select the first device regardless of its address.
+**/
#define BLUETOOTH_CHOOSER_COMBO_FIRST_DEVICE "00:00:00:00:00:00"
typedef struct _BluetoothChooserComboPrivate BluetoothChooserComboPrivate;
diff --git a/lib/bluetooth-client.c b/lib/bluetooth-client.c
index 73e987d..e230bd2 100644
--- a/lib/bluetooth-client.c
+++ b/lib/bluetooth-client.c
@@ -1300,20 +1300,50 @@ static void bluetooth_client_class_init(BluetoothClientClass *klass)
object_class->get_property = bluetooth_client_get_property;
object_class->set_property = bluetooth_client_set_property;
+ /**
+ * BluetoothClient:default-adapter:
+ *
+ * The D-Bus path of the default Bluetooth adapter or %NULL.
+ */
g_object_class_install_property (object_class, PROP_DEFAULT_ADAPTER,
- g_param_spec_string ("default-adapter", NULL, NULL,
+ g_param_spec_string ("default-adapter", NULL,
+ "The D-Bus path of the default adapter",
NULL, G_PARAM_READABLE));
+ /**
+ * BluetoothClient:default-adapter-powered:
+ *
+ * %TRUE if the default Bluetooth adapter is powered.
+ */
g_object_class_install_property (object_class, PROP_DEFAULT_ADAPTER_POWERED,
- g_param_spec_boolean ("default-adapter-powered", NULL, NULL,
+ g_param_spec_boolean ("default-adapter-powered", NULL,
+ "Whether the default adapter is powered",
FALSE, G_PARAM_READABLE));
+ /**
+ * BluetoothClient:default-adapter-discoverable:
+ *
+ * %TRUE if the default Bluetooth adapter is discoverable.
+ */
g_object_class_install_property (object_class, PROP_DEFAULT_ADAPTER_DISCOVERABLE,
- g_param_spec_boolean ("default-adapter-discoverable", NULL, NULL,
+ g_param_spec_boolean ("default-adapter-discoverable", NULL,
+ "Whether the default adapter is visible by other devices",
FALSE, G_PARAM_READWRITE));
+ /**
+ * BluetoothClient:default-adapter-name:
+ *
+ * The name of the default Bluetooth adapter or %NULL.
+ */
g_object_class_install_property (object_class, PROP_DEFAULT_ADAPTER_NAME,
- g_param_spec_string ("default-adapter-name", NULL, NULL,
+ g_param_spec_string ("default-adapter-name", NULL,
+ "The human readable name of the default adapter",
NULL, G_PARAM_READABLE));
+ /**
+ * BluetoothClient:default-adapter-discovering:
+ *
+ * %TRUE if the default Bluetooth adapter is discovering.
+ */
g_object_class_install_property (object_class, PROP_DEFAULT_ADAPTER_DISCOVERING,
- g_param_spec_boolean ("default-adapter-discovering", NULL, NULL,
+ g_param_spec_boolean ("default-adapter-discovering", NULL,
+ "Whether the default adapter is searching for devices",
FALSE, G_PARAM_READWRITE));
if (error != NULL) {
diff --git a/lib/bluetooth-enums.h b/lib/bluetooth-enums.h
index a8411eb..5874037 100644
--- a/lib/bluetooth-enums.h
+++ b/lib/bluetooth-enums.h
@@ -97,7 +97,17 @@ typedef enum {
#define _BLUETOOTH_TYPE_NUM_TYPES 15
+/**
+ * BLUETOOTH_TYPE_INPUT:
+ *
+ * Use this value to select any Bluetooth input device where a #BluetoothType enum is required.
+ */
#define BLUETOOTH_TYPE_INPUT (BLUETOOTH_TYPE_KEYBOARD | BLUETOOTH_TYPE_MOUSE | BLUETOOTH_TYPE_TABLET | BLUETOOTH_TYPE_JOYPAD)
+/**
+ * BLUETOOTH_TYPE_AUDIO:
+ *
+ * Use this value to select any Bluetooth audio device where a #BluetoothType enum is required.
+ */
#define BLUETOOTH_TYPE_AUDIO (BLUETOOTH_TYPE_HEADSET | BLUETOOTH_TYPE_HEADPHONES | BLUETOOTH_TYPE_OTHER_AUDIO)
/**
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]