summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAleksander Morgado <aleksander@lanedo.com>2012-10-10 18:24:11 +0200
committerAleksander Morgado <aleksander@lanedo.com>2012-10-10 18:24:11 +0200
commit5e1507472d695a6add54ca257a0aef740ee434ec (patch)
treebcd27f78f18ec3317c4dd44ea998c7ee5b63f36b
parentf367a4c8b5629047b17bbed100de7ffa0afad404 (diff)
libqmi-glib,device: include missing `qmi_device_command()' documentation
-rw-r--r--libqmi-glib/qmi-device.c24
1 files changed, 24 insertions, 0 deletions
diff --git a/libqmi-glib/qmi-device.c b/libqmi-glib/qmi-device.c
index 7bfc0a3..e8d801c 100644
--- a/libqmi-glib/qmi-device.c
+++ b/libqmi-glib/qmi-device.c
@@ -1650,6 +1650,16 @@ qmi_device_close (QmiDevice *self,
/*****************************************************************************/
/* Command */
+/**
+ * qmi_device_command_finish:
+ * @self: a #QmiDevice.
+ * @res: a #GAsyncResult.
+ * @error: Return location for error or %NULL.
+ *
+ * Finishes an operation started with qmi_device_command().
+ *
+ * Returns: a #QmiMessage response, or #NULL if @error is set. The returned value should be freed with qmi_message_unref().
+ */
QmiMessage *
qmi_device_command_finish (QmiDevice *self,
GAsyncResult *res,
@@ -1662,6 +1672,20 @@ qmi_device_command_finish (QmiDevice *self,
G_SIMPLE_ASYNC_RESULT (res)));
}
+/**
+ * qmi_device_command:
+ * @self: a #QmiDevice.
+ * @message: the message to send.
+ * @timeout: maximum time, in seconds, to wait for the response.
+ * @cancellable: a #GCancellable, or %NULL.
+ * @callback: a #GAsyncReadyCallback to call when the operation is finished.
+ * @user_data: the data to pass to callback function.
+ *
+ * Asynchronously sends a #QmiMessage to the device.
+ *
+ * When the operation is finished @callback will be called. You can then call
+ * qmi_device_command_finish() to get the result of the operation.
+ */
void
qmi_device_command (QmiDevice *self,
QmiMessage *message,