[Spice-devel] [PATCH spice-gtk 1/6] usb-device-manager: Fix docstring

Pavel Grunt pgrunt at redhat.com
Wed Mar 30 07:00:16 UTC 2016


Add description, "Since" and change the parameter name in the docstring
to match parameter name in the function definition.
---
 doc/reference/spice-gtk-sections.txt |  1 +
 src/usb-device-manager.c             | 14 +++++++++-----
 2 files changed, 10 insertions(+), 5 deletions(-)

diff --git a/doc/reference/spice-gtk-sections.txt b/doc/reference/spice-gtk-sections.txt
index 8947893..0c05168 100644
--- a/doc/reference/spice-gtk-sections.txt
+++ b/doc/reference/spice-gtk-sections.txt
@@ -311,6 +311,7 @@ spice_usb_device_manager_get
 spice_usb_device_manager_get_devices
 spice_usb_device_manager_get_devices_with_filter
 spice_usb_device_manager_is_device_connected
+spice_usb_device_manager_is_redirecting
 spice_usb_device_manager_disconnect_device
 spice_usb_device_manager_can_redirect_device
 spice_usb_device_manager_connect_device_async
diff --git a/src/usb-device-manager.c b/src/usb-device-manager.c
index c36a9a8..da7e596 100644
--- a/src/usb-device-manager.c
+++ b/src/usb-device-manager.c
@@ -232,11 +232,15 @@ G_DEFINE_BOXED_TYPE(SpiceUsbDevice, spice_usb_device, g_object_ref, g_object_unr
 #endif
 
 /**
-* spice_usb_device_manager_is_redirecting:
-* @manager: the #SpiceUsbDeviceManager manager
-*
-* Returns: %TRUE if device redirection negotiation flow is in progress
-*/
+ * spice_usb_device_manager_is_redirecting:
+ * @self: the #SpiceUsbDeviceManager manager
+ *
+ * Checks whether a device is being redirected
+ *
+ * Returns: %TRUE if device redirection negotiation flow is in progress
+ *
+ * Since: 0.32
+ */
 gboolean spice_usb_device_manager_is_redirecting(SpiceUsbDeviceManager *self)
 {
 #ifdef USE_USBREDIR
-- 
2.7.4



More information about the Spice-devel mailing list