[gnome-bluetooth] Loads of API documentation fixes

From: Bastien Nocera <hadess src gnome org>
To: svn-commits-list gnome org
Cc:
Subject: [gnome-bluetooth] Loads of API documentation fixes
Date: Fri, 11 Dec 2009 16:56:56 +0000 (UTC)
commit e48b50b8d703fe820497d6bdb559f6940def7285
Author: Bastien Nocera <hadess hadess net>
Date:   Fri Dec 11 16:56:28 2009 +0000

    Loads of API documentation fixes

 docs/reference/libgnome-bluetooth/Makefile.am      |    7 ++-
 .../gnome-bluetooth-sections.txt                   |   18 -------
 lib/bluetooth-chooser-button.c                     |   16 ++++++-
 lib/bluetooth-chooser-combo.c                      |    4 +-
 lib/bluetooth-chooser.c                            |   45 ++++++++++++++---
 lib/bluetooth-client.c                             |   52 ++++++++++++++++----
 lib/bluetooth-enums.h                              |    9 +++
 lib/bluetooth-filter-widget.c                      |    5 +-
 lib/bluetooth-killswitch.c                         |    9 +++
 lib/bluetooth-plugin-manager.c                     |   39 +++++++++++++++
 lib/bluetooth-plugin.h                             |    9 +++
 lib/rfkill.h                                       |   34 ++++++------
 12 files changed, 189 insertions(+), 58 deletions(-)
---
diff --git a/docs/reference/libgnome-bluetooth/Makefile.am b/docs/reference/libgnome-bluetooth/Makefile.am
index cca48b2..5976ef9 100644
--- a/docs/reference/libgnome-bluetooth/Makefile.am
+++ b/docs/reference/libgnome-bluetooth/Makefile.am
@@ -54,7 +54,7 @@ CFILE_GLOB=$(top_srcdir)/lib/*.c
 
 # Header files to ignore when scanning.
 # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
-IGNORE_HFILES=bluetooth-agent-glue.h bluetooth-agent.h bluetooth-client-glue.h bluetooth-client-private.h bluetooth-chooser-private.h bluetooth-instance-glue.h bluetooth-instance.h helper.h marshal.h obex-agent-glue.h obex-agent.h
+IGNORE_HFILES=bluetooth-agent-glue.h bluetooth-agent.h bluetooth-client-glue.h bluetooth-client-private.h bluetooth-chooser-private.h bluetooth-instance-glue.h bluetooth-instance.h bluetooth-killswitch.h helper.h marshal.h obex-agent-glue.h obex-agent.h rfkill.h bluetooth-filter-widget.h
 
 # Images to copy into HTML directory.
 # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
@@ -92,3 +92,8 @@ EXTRA_DIST += version.xml.in
 # Comment this out if you want your docs-status tested during 'make check'
 #TESTS = $(GTKDOC_CHECK)
 
+if ENABLE_GTK_DOC
+TESTS_ENVIRONMENT = cd $(srcdir) &&
+TESTS = $(GTKDOC_CHECK)
+endif
+
diff --git a/docs/reference/libgnome-bluetooth/gnome-bluetooth-sections.txt b/docs/reference/libgnome-bluetooth/gnome-bluetooth-sections.txt
index 91187a2..2ceda4e 100644
--- a/docs/reference/libgnome-bluetooth/gnome-bluetooth-sections.txt
+++ b/docs/reference/libgnome-bluetooth/gnome-bluetooth-sections.txt
@@ -78,24 +78,6 @@ bluetooth_chooser_button_get_type
 </SECTION>
 
 <SECTION>
-<FILE>bling-spinner</FILE>
-BlingSpinnerPrivate
-<TITLE>BlingSpinner</TITLE>
-BlingSpinner
-bling_spinner_new
-bling_spinner_start
-bling_spinner_stop
-<SUBSECTION Standard>
-BLING_SPINNER
-BLING_IS_SPINNER
-BLING_TYPE_SPINNER
-bling_spinner_get_type
-BLING_SPINNER_CLASS
-BLING_IS_SPINNER_CLASS
-BLING_SPINNER_GET_CLASS
-</SECTION>
-
-<SECTION>
 <FILE>gnome-bluetooth-enum-types</FILE>
 bluetooth_category_get_type
 BLUETOOTH_TYPE_CATEGORY
diff --git a/lib/bluetooth-chooser-button.c b/lib/bluetooth-chooser-button.c
index 22a190b..e61797d 100644
--- a/lib/bluetooth-chooser-button.c
+++ b/lib/bluetooth-chooser-button.c
@@ -18,6 +18,16 @@
  * Boston, MA 02111-1307, USA.
  */
 
+/**
+ * SECTION:bluetooth-chooser-button
+ * @short_description: a Bluetooth chooser button
+ * @stability: Stable
+ * @include: bluetooth-plugin.h
+ *
+ * A button used to select Bluetooth devices which will pop-up a
+ * #BluetoothChooser widget inside a dialogue when clicked.
+ **/
+
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
@@ -379,7 +389,9 @@ bluetooth_chooser_button_init (BluetoothChooserButton *button)
 /**
  * bluetooth_chooser_button_new:
  *
- * Return value: a #BluetoothChooserButton
+ * Returns a new #BluetoothChooserButton widget.
+ *
+ * Return value: a #BluetoothChooserButton widget.
  **/
 GtkWidget *
 bluetooth_chooser_button_new (void)
@@ -393,6 +405,8 @@ bluetooth_chooser_button_new (void)
  * bluetooth_chooser_button_available:
  * @button: a #BluetoothChooserButton
  *
+ * Returns whether there is a powered Bluetooth adapter.
+ *
  * Return value: %TRUE if there is a powered Bluetooth adapter available, and the button should be sensitive.
  **/
 gboolean
diff --git a/lib/bluetooth-chooser-combo.c b/lib/bluetooth-chooser-combo.c
index f4195ca..3de2145 100644
--- a/lib/bluetooth-chooser-combo.c
+++ b/lib/bluetooth-chooser-combo.c
@@ -338,7 +338,9 @@ bluetooth_chooser_combo_init (BluetoothChooserCombo *combo)
 /**
  * bluetooth_chooser_combo_new:
  *
- * Return value: a #BluetoothChooserCombo
+ * Returns a new #BluetoothChooserCombo widget.
+ *
+ * Return value: a #BluetoothChooserCombo widget.
  **/
 GtkWidget *
 bluetooth_chooser_combo_new (void)
diff --git a/lib/bluetooth-chooser.c b/lib/bluetooth-chooser.c
index addc93f..4b5eb91 100644
--- a/lib/bluetooth-chooser.c
+++ b/lib/bluetooth-chooser.c
@@ -22,6 +22,15 @@
  *
  */
 
+/**
+ * SECTION:bluetooth-chooser
+ * @short_description: a Bluetooth chooser widget
+ * @stability: Stable
+ * @include: bluetooth-plugin.h
+ *
+ * A tree-like widget used to select Bluetooth devices.
+ **/
+
 #ifdef HAVE_CONFIG_H
 #include <config.h>
 #endif
@@ -225,6 +234,8 @@ bluetooth_chooser_get_selected_device_data (BluetoothChooser *self, guint column
  * bluetooth_chooser_get_selected_device:
  * @self: a #BluetoothChooser widget.
  *
+ * Returns the Bluetooth address for the currently selected device.
+ *
  * Return value: the Bluetooth address for the currently selected device, or %NULL.
  **/
 gchar *
@@ -237,6 +248,8 @@ bluetooth_chooser_get_selected_device (BluetoothChooser *self)
  * bluetooth_chooser_get_selected_device_name:
  * @self: a #BluetoothChooser widget.
  *
+ * Returns the name for the currently selected device.
+ *
  * Return value: the name for the currently selected device, or %NULL.
  **/
 gchar *
@@ -249,6 +262,8 @@ bluetooth_chooser_get_selected_device_name (BluetoothChooser *self)
  * bluetooth_chooser_get_selected_device_icon:
  * @self: a #BluetoothChooser widget.
  *
+ * Returns the icon name to use to represent the currently selected device.
+ *
  * Return value: the icon name to use to represent the currently selected device, or %NULL.
  **/
 gchar *
@@ -261,6 +276,8 @@ bluetooth_chooser_get_selected_device_icon (BluetoothChooser *self)
  * bluetooth_chooser_get_selected_device_type:
  * @self: a #BluetoothChooser widget.
  *
+ * Returns the #BluetoothType of the device selected.
+ *
  * Return value: the #BluetoothType of the device selected, or '0' if unknown.
  **/
 BluetoothType
@@ -283,7 +300,9 @@ bluetooth_chooser_get_selected_device_type (BluetoothChooser *self)
  * bluetooth_chooser_get_selected_device_is_connected:
  * @self: a #BluetoothChooser widget.
  *
- * Return value: whether the selected device is conncted to this computer,
+ * Returns whether the selected device is connected to this computer.
+ *
+ * Return value: whether the selected device is connected to this computer,
  * will always be %FALSE if no devices are selected.
  **/
 gboolean
@@ -307,6 +326,8 @@ bluetooth_chooser_get_selected_device_is_connected (BluetoothChooser *self)
  * @field: The identifier for the field to get data for.
  * @value: An empty #GValue to set.
  *
+ * Returns whether the @value has been set.
+ *
  * Return value: %TRUE if the @value has been set.
  **/
 gboolean
@@ -370,6 +391,8 @@ show_confirm_dialog (BluetoothChooser *chooser, const char *name)
  * bluetooth_chooser_remove_selected_device:
  * @self: A #BluetoothChooser widget.
  *
+ * Returns whether the removal was successful.
+ *
  * Return value: %TRUE if the selected device was correctly removed.
  **/
 gboolean
@@ -413,9 +436,11 @@ bluetooth_chooser_remove_selected_device (BluetoothChooser *self)
 
 /**
  * bluetooth_chooser_get_model:
- * @self: A BluetoothChooser widget.
+ * @self: A #BluetoothChooser widget.
  *
- * Return value: The BluetoothChooser's GtkTreeModel.
+ * Returns the #BluetoothChooser's #GtkTreeModel.
+ *
+ * Return value: a #GtkTreeModel object.
  **/
 GtkTreeModel *
 bluetooth_chooser_get_model (BluetoothChooser *self)
@@ -427,9 +452,11 @@ bluetooth_chooser_get_model (BluetoothChooser *self)
 
 /**
  * bluetooth_chooser_get_type_column:
- * @self: A BluetoothChooser widget.
+ * @self: A #BluetoothChooser widget.
  *
- * Return value: A GtkTreeViewColumn pointer to the type column of the BluetoothChooser.
+ * Returns a #GtkTreeViewColumn object to the type column of the #BluetoothChooser.
+ *
+ * Return value: a #GtkTreeViewColumn object.
  **/
 GtkTreeViewColumn *
 bluetooth_chooser_get_type_column (BluetoothChooser *self)
@@ -441,9 +468,11 @@ bluetooth_chooser_get_type_column (BluetoothChooser *self)
 
 /**
  * bluetooth_chooser_get_treeview:
- * @self: A BluetoothChooser widget.
+ * @self: A #BluetoothChooser widget.
  *
- * Return value: The #GtkTreeView pointer for the #BluetoothChooser.
+ * Returns the #GtkTreeView object for the #BluetoothChooser.
+ *
+ * Return value: a #GtkTreeView object.
  **/
 GtkWidget *
 bluetooth_chooser_get_treeview (BluetoothChooser *self)
@@ -1161,6 +1190,8 @@ bluetooth_chooser_class_init (BluetoothChooserClass *klass)
  * bluetooth_chooser_new:
  * @title: the widget header title, if %NULL, the widget header will be hidden.
  *
+ * Returns a new #BluetoothChooser widget.
+ *
  * Return value: A #BluetoothChooser widget
  **/
 GtkWidget *
diff --git a/lib/bluetooth-client.c b/lib/bluetooth-client.c
index 8952bbc..bc1a167 100644
--- a/lib/bluetooth-client.c
+++ b/lib/bluetooth-client.c
@@ -21,6 +21,16 @@
  *
  */
 
+/**
+ * SECTION:bluetooth-client
+ * @short_description: Bluetooth client object
+ * @stability: Stable
+ * @include: bluetooth-client.h
+ *
+ * The #BluetoothClient object is used to query the state of Bluetooth
+ * devices and adapters.
+ **/
+
 #ifdef HAVE_CONFIG_H
 #include <config.h>
 #endif
@@ -106,7 +116,9 @@ G_DEFINE_TYPE(BluetoothClient, bluetooth_client, G_TYPE_OBJECT)
  * bluetooth_type_to_string:
  * @type: a #BluetoothType
  *
- * Return value: the string representation of the @type passed. Do not free the return value.
+ * Returns the string representation of the @type passed. Do not free the return value.
+ *
+ * Return value: a string.
  **/
 const gchar *bluetooth_type_to_string(BluetoothType type)
 {
@@ -149,7 +161,9 @@ const gchar *bluetooth_type_to_string(BluetoothType type)
  * bluetooth_verify_address:
  * @bdaddr: a string representing a Bluetooth address
  *
- * Return value: Whether the string is a valid Bluetooth address. This does not contact the device in any way.
+ * Returns whether the string is a valid Bluetooth address. This does not contact the device in any way.
+ *
+ * Return value: %TRUE if the address is valid, %FALSE if not.
  **/
 gboolean
 bluetooth_verify_address (const char *bdaddr)
@@ -555,7 +569,9 @@ uuid16_to_string (guint uuid16, const char *uuid)
  * bluetooth_uuid_to_string:
  * @uuid: a string representing a Bluetooth UUID
  *
- * Return value: a string representing a human-readable (but not usable for display to users) version of the @uuid. Do not free the return value.
+ * Returns a string representing a human-readable (but not usable for display to users) version of the @uuid. Do not free the return value.
+ *
+ * Return value: a string.
  **/
 const char *
 bluetooth_uuid_to_string (const char *uuid)
@@ -1255,7 +1271,9 @@ static void bluetooth_client_class_init(BluetoothClientClass *klass)
 /**
  * bluetooth_client_new:
  *
- * Return value: a reference to the #BluetoothClient singleton. Unref the object when done.
+ * Returns a reference to the #BluetoothClient singleton. Use #g_object_unref() the object when done.
+ *
+ * Return value: a #BluetoothClient object.
  **/
 BluetoothClient *bluetooth_client_new(void)
 {
@@ -1277,7 +1295,9 @@ BluetoothClient *bluetooth_client_new(void)
  * bluetooth_client_get_model:
  * @client: a #BluetoothClient object
  *
- * Return value: an unfiltered #GtkTreeModel representing the adapter and devices available on the system.
+ * Returns an unfiltered #GtkTreeModel representing the adapter and devices available on the system.
+ *
+ * Return value: a #GtkTreeModel object.
  **/
 GtkTreeModel *bluetooth_client_get_model (BluetoothClient *client)
 {
@@ -1301,7 +1321,9 @@ GtkTreeModel *bluetooth_client_get_model (BluetoothClient *client)
  * @data: user data to pass to gtk_tree_model_filter_set_visible_func()
  * @destroy: a destroy function for gtk_tree_model_filter_set_visible_func()
  *
- * Return value: a #GtkTreeModel of devices filtered using the @func, @data and @destroy arguments to pass to gtk_tree_model_filter_set_visible_func().
+ * Returns a #GtkTreeModel of devices filtered using the @func, @data and @destroy arguments to pass to gtk_tree_model_filter_set_visible_func().
+ *
+ * Return value: a #GtkTreeModel object.
  **/
 GtkTreeModel *bluetooth_client_get_filter_model (BluetoothClient *client,
 						 GtkTreeModelFilterVisibleFunc func,
@@ -1346,7 +1368,9 @@ static gboolean adapter_filter(GtkTreeModel *model,
  * bluetooth_client_get_adapter_model:
  * @client: a #BluetoothClient object
  *
- * Return value: a filtered #GtkTreeModel with only adapters present.
+ * Returns a filtered #GtkTreeModel with only adapters present.
+ *
+ * Return value: a #GtkTreeModel object.
  **/
 GtkTreeModel *bluetooth_client_get_adapter_model (BluetoothClient *client)
 {
@@ -1361,7 +1385,9 @@ GtkTreeModel *bluetooth_client_get_adapter_model (BluetoothClient *client)
  * @client: a #BluetoothClient object
  * @adapter: a #DBusGProxy of the adapter object, or %NULL to get the default adapter.
  *
- * Return value: a filtered #GtkTreeModel with only devices belonging to the selected adapter listed. Note that the model will follow a specific adapter, and will not follow the default-adapter when %NULL is passed.
+ * Returns a filtered #GtkTreeModel with only devices belonging to the selected adapter listed. Note that the model will follow a specific adapter, and will not follow the default-adapter when %NULL is passed.
+ *
+ * Return value: a #GtkTreeModel object.
  **/
 GtkTreeModel *bluetooth_client_get_device_model (BluetoothClient *client,
 						 DBusGProxy *adapter)
@@ -1418,11 +1444,15 @@ GtkTreeModel *bluetooth_client_get_device_model (BluetoothClient *client,
 /**
  * bluetooth_client_get_device_filter_model:
  * @client: a #BluetoothClient object
+ * @adapter: a #DBusGProxy representing a particular adapter, or %NULL for the default adapter.
  * @func: a #GtkTreeModelFilterVisibleFunc
  * @data: user data to pass to gtk_tree_model_filter_set_visible_func()
  * @destroy: a destroy function for gtk_tree_model_filter_set_visible_func()
  *
- * Return value: a #GtkTreeModel of adapters filtered using the @func, @data and @destroy arguments to pass to gtk_tree_model_filter_set_visible_func().
+ * Returns a #GtkTreeModel of adapters filtered using the @func, @data and
+ * @destroy arguments to pass to gtk_tree_model_filter_set_visible_func().
+ *
+ * Return value: a #GtkTreeModel object.
  **/
 GtkTreeModel *bluetooth_client_get_device_filter_model(BluetoothClient *client,
 		DBusGProxy *adapter, GtkTreeModelFilterVisibleFunc func,
@@ -1446,7 +1476,9 @@ GtkTreeModel *bluetooth_client_get_device_filter_model(BluetoothClient *client,
  * bluetooth_client_get_default_adapter:
  * @client: a #BluetoothClient object
  *
- * Return value: a #DBusGProxy object representing the default adapter, or %NULL if no adapters are present.
+ * Returns a #DBusGProxy object representing the default adapter, or %NULL if no adapters are present.
+ *
+ * Return value: a #DBusGProxy object.
  **/
 DBusGProxy *bluetooth_client_get_default_adapter(BluetoothClient *client)
 {
diff --git a/lib/bluetooth-enums.h b/lib/bluetooth-enums.h
index e9b084f..0d189b4 100644
--- a/lib/bluetooth-enums.h
+++ b/lib/bluetooth-enums.h
@@ -29,6 +29,15 @@
 G_BEGIN_DECLS
 
 /**
+ * SECTION:bluetooth-enums
+ * @short_description: Bluetooth related enumerations
+ * @stability: Stable
+ * @include: bluetooth-enums.h
+ *
+ * Enumerations related to Bluetooth.
+ **/
+
+/**
  * BluetoothCategory:
  * @BLUETOOTH_CATEGORY_ALL: all devices
  * @BLUETOOTH_CATEGORY_PAIRED: paired devices
diff --git a/lib/bluetooth-filter-widget.c b/lib/bluetooth-filter-widget.c
index d58ee7a..96f1a04 100644
--- a/lib/bluetooth-filter-widget.c
+++ b/lib/bluetooth-filter-widget.c
@@ -480,14 +480,13 @@ bluetooth_filter_widget_class_init (BluetoothFilterWidgetClass *klass)
 
 /**
  * bluetooth_filter_widget_new:
- * @chooser: The #BluetoothChooser to filter
  *
- * Return value: A #BluetoothFilterWidget widget
- * 
  * Creates a new #BluetoothFilterWidget which can be bound to a #BluetoothChooser to
  * control filtering of that #BluetoothChooser.
  * Usually used in conjunction with a #BluetoothChooser which has the "has-internal-filter"
  * property set to FALSE.
+ *
+ * Return value: A #BluetoothFilterWidget widget
  * 
  * Note: Must call bluetooth_filter_widget_bind_filter () to bind the #BluetoothFilterWidget
  * to a #BluetoothChooser.
diff --git a/lib/bluetooth-killswitch.c b/lib/bluetooth-killswitch.c
index 36f74e8..9c5a70e 100644
--- a/lib/bluetooth-killswitch.c
+++ b/lib/bluetooth-killswitch.c
@@ -22,6 +22,15 @@
  *
  */
 
+/**
+ * SECTION:bluetooth-killswitch
+ * @short_description: a Bluetooth killswitch object
+ * @stability: Stable
+ * @include: bluetooth-killswitch.h
+ *
+ * An object to manipulate Bluetooth killswitches.
+ **/
+
 #ifdef HAVE_CONFIG_H
 #include <config.h>
 #endif
diff --git a/lib/bluetooth-plugin-manager.c b/lib/bluetooth-plugin-manager.c
index 5606610..f8a4a65 100644
--- a/lib/bluetooth-plugin-manager.c
+++ b/lib/bluetooth-plugin-manager.c
@@ -21,6 +21,16 @@
  *
  */
 
+/**
+ * SECTION:bluetooth-plugin-manager
+ * @short_description: Bluetooth plug-in manager
+ * @stability: Stable
+ * @include: bluetooth-plugin-manager.h
+ *
+ * The plugin manager is used to extend set up wizards, or preferences.
+ **/
+
+
 #ifdef HAVE_CONFIG_H
 #include <config.h>
 #endif
@@ -83,6 +93,13 @@ bluetooth_plugin_dir_process (const char *plugindir)
 	}
 }
 
+/**
+ * bluetooth_plugin_manager_init:
+ *
+ * Initialise the plugin manager for Bluetooth plugins.
+ *
+ * Return value: %TRUE if the initialisation succedeed, %FALSE otherwise.
+ **/
 gboolean
 bluetooth_plugin_manager_init (void)
 {
@@ -96,6 +113,11 @@ bluetooth_plugin_manager_init (void)
 	return g_list_length (plugin_list) != 0;
 }
 
+/**
+ * bluetooth_plugin_manager_cleanup:
+ *
+ * Free all the resources used by the Bluetooth plugins.
+ **/
 void
 bluetooth_plugin_manager_cleanup (void)
 {
@@ -113,6 +135,16 @@ bluetooth_plugin_manager_cleanup (void)
 	plugin_list = NULL;
 }
 
+/**
+ * bluetooth_plugin_manager_get_widgets:
+ * @bdaddr: a Bluetooth address representing a device
+ * @uuids: an array of UUIDs supported by the device.
+ *
+ * Returns a list of widgets suitable for configuring the device
+ * represented by @address, for the services listed in @uuids.
+ *
+ * Return value: a #GList of #GtkWidget, or %NULL is none.
+ **/
 GList *
 bluetooth_plugin_manager_get_widgets (const char *bdaddr,
 				      const char **uuids)
@@ -132,6 +164,13 @@ bluetooth_plugin_manager_get_widgets (const char *bdaddr,
 	return ret;
 }
 
+/**
+ * bluetooth_plugin_manager_device_deleted:
+ * @bdaddr: a Bluetooth address representing a device
+ *
+ * Removes all existing configuration for the device, as
+ * supported by the plug-ins.
+ **/
 void
 bluetooth_plugin_manager_device_deleted (const char *bdaddr)
 {
diff --git a/lib/bluetooth-plugin.h b/lib/bluetooth-plugin.h
index 8fdc997..ff32321 100644
--- a/lib/bluetooth-plugin.h
+++ b/lib/bluetooth-plugin.h
@@ -4,6 +4,15 @@
 #include <gmodule.h>
 #include <gtk/gtk.h>
 
+/**
+ * SECTION:bluetooth-plugin
+ * @short_description: Bluetooth plug-in
+ * @stability: Stable
+ * @include: bluetooth-plugin.h
+ *
+ * Plug-ins can be used to extend set up wizards and preferences.
+ **/
+
 typedef struct _GbtPluginInfo GbtPluginInfo;
 typedef struct _GbtPlugin GbtPlugin;
 
diff --git a/lib/rfkill.h b/lib/rfkill.h
index ee3edde..cde6a2d 100644
--- a/lib/rfkill.h
+++ b/lib/rfkill.h
@@ -29,7 +29,7 @@
 #define RFKILL_STATE_UNBLOCKED		1
 #define RFKILL_STATE_HARD_BLOCKED	2
 
-/**
+/*
  * enum rfkill_type - type of rfkill switch.
  *
  * @RFKILL_TYPE_ALL: toggles all switches (userspace only)
@@ -50,7 +50,7 @@ enum rfkill_type {
 	NUM_RFKILL_TYPES,
 };
 
-/**
+/*
  * enum rfkill_operation - operation types
  * @RFKILL_OP_ADD: a device was added
  * @RFKILL_OP_DEL: a device was removed
@@ -64,7 +64,7 @@ enum rfkill_operation {
 	RFKILL_OP_CHANGE_ALL,
 };
 
-/**
+/*
  * struct rfkill_event - events for userspace on /dev/rfkill
  * @idx: index of dev rfkill
  * @type: type of the rfkill struct
@@ -109,7 +109,7 @@ enum rfkill_user_states {
 /* this is opaque */
 struct rfkill;
 
-/**
+/*
  * struct rfkill_ops - rfkill driver methods
  *
  * @poll: poll the rfkill block state(s) -- only assign this method
@@ -134,7 +134,7 @@ struct rfkill_ops {
 };
 
 #if defined(CONFIG_RFKILL) || defined(CONFIG_RFKILL_MODULE)
-/**
+/*
  * rfkill_alloc - allocate rfkill structure
  * @name: name of the struct -- the string is not copied internally
  * @parent: device that has rf switch on it
@@ -151,7 +151,7 @@ struct rfkill * __must_check rfkill_alloc(const char *name,
 					  const struct rfkill_ops *ops,
 					  void *ops_data);
 
-/**
+/*
  * rfkill_register - Register a rfkill structure.
  * @rfkill: rfkill structure to be registered
  *
@@ -161,7 +161,7 @@ struct rfkill * __must_check rfkill_alloc(const char *name,
  */
 int __must_check rfkill_register(struct rfkill *rfkill);
 
-/**
+/*
  * rfkill_pause_polling(struct rfkill *rfkill)
  *
  * Pause polling -- say transmitter is off for other reasons.
@@ -170,7 +170,7 @@ int __must_check rfkill_register(struct rfkill *rfkill);
  */
 void rfkill_pause_polling(struct rfkill *rfkill);
 
-/**
+/*
  * rfkill_resume_polling(struct rfkill *rfkill)
  *
  * Pause polling -- say transmitter is off for other reasons.
@@ -180,7 +180,7 @@ void rfkill_pause_polling(struct rfkill *rfkill);
 void rfkill_resume_polling(struct rfkill *rfkill);
 
 
-/**
+/*
  * rfkill_unregister - Unregister a rfkill structure.
  * @rfkill: rfkill structure to be unregistered
  *
@@ -190,7 +190,7 @@ void rfkill_resume_polling(struct rfkill *rfkill);
  */
 void rfkill_unregister(struct rfkill *rfkill);
 
-/**
+/*
  * rfkill_destroy - free rfkill structure
  * @rfkill: rfkill structure to be destroyed
  *
@@ -198,7 +198,7 @@ void rfkill_unregister(struct rfkill *rfkill);
  */
 void rfkill_destroy(struct rfkill *rfkill);
 
-/**
+/*
  * rfkill_set_hw_state - Set the internal rfkill hardware block state
  * @rfkill: pointer to the rfkill class to modify.
  * @state: the current hardware block state to set
@@ -219,7 +219,7 @@ void rfkill_destroy(struct rfkill *rfkill);
  */
 bool __must_check rfkill_set_hw_state(struct rfkill *rfkill, bool blocked);
 
-/**
+/*
  * rfkill_set_sw_state - Set the internal rfkill software block state
  * @rfkill: pointer to the rfkill class to modify.
  * @state: the current software block state to set
@@ -238,7 +238,7 @@ bool __must_check rfkill_set_hw_state(struct rfkill *rfkill, bool blocked);
  */
 bool rfkill_set_sw_state(struct rfkill *rfkill, bool blocked);
 
-/**
+/*
  * rfkill_set_states - Set the internal rfkill block states
  * @rfkill: pointer to the rfkill class to modify.
  * @sw: the current software block state to set
@@ -249,7 +249,7 @@ bool rfkill_set_sw_state(struct rfkill *rfkill, bool blocked);
  */
 void rfkill_set_states(struct rfkill *rfkill, bool sw, bool hw);
 
-/**
+/*
  * rfkill_set_global_sw_state - set global sw block default
  * @type: rfkill type to set default for
  * @blocked: default to set
@@ -262,7 +262,7 @@ void rfkill_set_states(struct rfkill *rfkill, bool sw, bool hw);
  */
 void rfkill_set_global_sw_state(const enum rfkill_type type, bool blocked);
 
-/**
+/*
  * rfkill_blocked - query rfkill block
  *
  * @rfkill: rfkill struct to query
@@ -329,14 +329,14 @@ static inline bool rfkill_blocked(struct rfkill *rfkill)
 
 
 #ifdef CONFIG_RFKILL_LEDS
-/**
+/*
  * rfkill_get_led_trigger_name - Get the LED trigger name for the button's LED.
  * This function might return a NULL pointer if registering of the
  * LED trigger failed. Use this as "default_trigger" for the LED.
  */
 const char *rfkill_get_led_trigger_name(struct rfkill *rfkill);
 
-/**
+/*
  * rfkill_set_led_trigger_name -- set the LED trigger name
  * @rfkill: rfkill struct
  * @name: LED trigger name
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]