From 1f9d446699b7377d23a05b1db35cf6d351da7825 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20Gl=C3=A4=C3=9Fle?= Date: Tue, 22 Nov 2016 00:08:03 +0100 Subject: [PATCH] Add doc-comments for _gstring launch functions --- src/udisksdaemon.c | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/src/udisksdaemon.c b/src/udisksdaemon.c index f8c0039..7a3f4a7 100644 --- a/src/udisksdaemon.c +++ b/src/udisksdaemon.c @@ -673,6 +673,36 @@ udisks_daemon_launch_spawned_job (UDisksDaemon *daemon, return job; } +/** + * udisks_daemon_launch_spawned_job_gstring: + * @daemon: A #UDisksDaemon. + * @object: (allow-none): A #UDisksObject to add to the job or %NULL. + * @job_operation: The operation for the job. + * @job_started_by_uid: The user who started the job. + * @cancellable: A #GCancellable or %NULL. + * @run_as_uid: The #uid_t to run the command as. + * @run_as_euid: The effective #uid_t to run the command as. + * @input_string: A string to write to stdin of the spawned program or %NULL. + * @command_line_format: printf()-style format for the command line to spawn. + * @...: Arguments for @command_line_format. + * + * Launches a new job for @command_line_format. + * + * The job is started immediately - connect to the + * #UDisksSpawnedJob::spawned-job-completed or #UDisksJob::completed + * signals to get notified when the job is done. + * + * The returned object will be exported on the bus until the + * #UDisksJob::completed signal is emitted on the object. It is not + * valid to use the returned object after this signal fires. + * + * This function is the same as udisks_daemon_launch_spawned_job, with + * the only difference that it takes a GString and is therefore able to + * handle binary inputs that contain NUL bytes. + * + * Returns: A #UDisksSpawnedJob object. Do not free, the object + * belongs to @manager. + */ UDisksBaseJob * udisks_daemon_launch_spawned_job_gstring ( UDisksDaemon *daemon, @@ -823,6 +853,30 @@ udisks_daemon_launch_spawned_job_sync (UDisksDaemon *daemon, return ret; } +/** + * udisks_daemon_launch_spawned_job_gstring_sync: + * @daemon: A #UDisksDaemon. + * @object: (allow-none): A #UDisksObject to add to the job or %NULL. + * @job_operation: The operation for the job. + * @job_started_by_uid: The user who started the job. + * @cancellable: A #GCancellable or %NULL. + * @run_as_uid: The #uid_t to run the command as. + * @run_as_euid: The effective #uid_t to run the command as. + * @input_string: A string to write to stdin of the spawned program or %NULL. + * @out_status: Return location for the @status parameter of the #UDisksSpawnedJob::spawned-job-completed signal. + * @out_message: Return location for the @message parameter of the #UDisksJob::completed signal. + * @command_line_format: printf()-style format for the command line to spawn. + * @...: Arguments for @command_line_format. + * + * Like udisks_daemon_launch_spawned_job() but blocks the calling + * thread until the job completes. + * + * This function is the same as udisks_daemon_launch_spawned_job_sync, with + * the only difference that it takes a GString and is therefore able to + * handle binary inputs that contain NUL bytes. + * + * Returns: The @success parameter of the #UDisksJob::completed signal. + */ gboolean udisks_daemon_launch_spawned_job_gstring_sync (UDisksDaemon *daemon, UDisksObject *object, -- 2.10.2