summaryrefslogtreecommitdiff
path: root/src/ostree/ot-admin-functions.c
diff options
context:
space:
mode:
authorColin Walters <walters@verbum.org>2013-08-17 08:41:31 -0400
committerColin Walters <walters@verbum.org>2013-08-17 08:41:31 -0400
commitabe2320039fdff9e04e648cdd24002957940322b (patch)
tree19db2ce1e37c1debebef1ecb2c8adc49c8a3a78b /src/ostree/ot-admin-functions.c
parent06d1a56bc9edf943c63c5e9ccc8ad630cdbe6c6d (diff)
downloadostree-abe2320039fdff9e04e648cdd24002957940322b.tar.gz
libostree: Fix many gtk-doc warnings
Diffstat (limited to 'src/ostree/ot-admin-functions.c')
-rw-r--r--src/ostree/ot-admin-functions.c11
1 files changed, 8 insertions, 3 deletions
diff --git a/src/ostree/ot-admin-functions.c b/src/ostree/ot-admin-functions.c
index ac45cb19..b2caa4c4 100644
--- a/src/ostree/ot-admin-functions.c
+++ b/src/ostree/ot-admin-functions.c
@@ -360,10 +360,15 @@ parse_kernel_commandline (OtOrderedHash **out_args,
/**
* ot_admin_find_booted_deployment:
+ * @target_sysroot: Root directory
+ * @deployments: (element-type OtDeployment): Loaded deployments
+ * @out_deployment: (out): The currently booted deployment
+ * @cancellable:
+ * @error:
*
- * Returns in @out_deployment the currently booted deployment using
- * the list in @deployments. Will always return %NULL if
- * @target_sysroot is not equal to "/".
+ * If the system is currently booted into a deployment in
+ * @deployments, set @out_deployment. Note that if @target_sysroot is
+ * not equal to "/", @out_deployment will always be set to %NULL.
*/
gboolean
ot_admin_find_booted_deployment (GFile *target_sysroot,