diff options
| author | Aleksander Morgado <aleksander@aleksander.es> | 2014-05-23 15:11:37 +0200 |
|---|---|---|
| committer | Aleksander Morgado <aleksander@aleksander.es> | 2014-07-31 18:42:24 +0200 |
| commit | 624c405e3212ccdc96d5f7dfffb8b9f7e755235c (patch) | |
| tree | 0c15808e477f54a697e520fc903296ee189758c0 | |
| parent | 3dd57ec0a7631da559208a996025eb625e395984 (diff) | |
| download | libmbim-624c405e3212ccdc96d5f7dfffb8b9f7e755235c.tar.gz | |
libmbim-glib,device: add missing documentation for mbim_device_open_full()
| -rw-r--r-- | src/libmbim-glib/mbim-device.c | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/src/libmbim-glib/mbim-device.c b/src/libmbim-glib/mbim-device.c index 4507267..f2e3fbf 100644 --- a/src/libmbim-glib/mbim-device.c +++ b/src/libmbim-glib/mbim-device.c @@ -1059,6 +1059,16 @@ device_open_context_complete_and_free (DeviceOpenContext *ctx) static void device_open_context_step (DeviceOpenContext *ctx); +/** + * mbim_device_open_full_finish: + * @self: a #MbimDevice. + * @res: a #GAsyncResult. + * @error: Return location for error or %NULL. + * + * Finishes an asynchronous open operation started with mbim_device_open_full(). + * + * Returns: %TRUE if successful, %FALSE if @error is set. + */ gboolean mbim_device_open_full_finish (MbimDevice *self, GAsyncResult *res, @@ -1238,6 +1248,23 @@ device_open_context_step (DeviceOpenContext *ctx) g_assert_not_reached (); } +/** + * mbim_device_open_full: + * @self: a #MbimDevice. + * @flags: a set of #MbimDeviceOpenFlags. + * @timeout: maximum time, in seconds, to wait for the device to be opened. + * @cancellable: optional #GCancellable object, #NULL to ignore. + * @callback: a #GAsyncReadyCallback to call when the operation is finished. + * @user_data: the data to pass to callback function. + * + * Asynchronously opens a #MbimDevice for I/O. + * + * This method is an extension of the generic mbim_device_open(), which allows + * launching the #MbimDevice with proxy support. + * + * When the operation is finished @callback will be called. You can then call + * mbim_device_open_full_finish() to get the result of the operation. + */ void mbim_device_open_full (MbimDevice *self, MbimDeviceOpenFlags flags, |