[ostree] libostree: Document and annotate some methods to quash g-ir-scanner warnings



commit 5c406132ce42a7ed9ec9da6726b0f0e2b702de02
Author: Colin Walters <walters verbum org>
Date:   Fri Sep 20 14:00:31 2013 -0400

    libostree: Document and annotate some methods to quash g-ir-scanner warnings
    
    Since warnings are bad.  Introspection is good.

 src/libostree/ostree-deployment.c |   18 ++++++++++++++++++
 src/libostree/ostree-sysroot.c    |    2 ++
 2 files changed, 20 insertions(+), 0 deletions(-)
---
diff --git a/src/libostree/ostree-deployment.c b/src/libostree/ostree-deployment.c
index 0a64641..db61c56 100644
--- a/src/libostree/ostree-deployment.c
+++ b/src/libostree/ostree-deployment.c
@@ -71,12 +71,24 @@ ostree_deployment_get_bootserial (OstreeDeployment *self)
   return self->bootserial;
 }
 
+/**
+ * ostree_deployment_get_bootconfig:
+ * @self: Deployment
+ *
+ * Returns: (transfer none): Boot configuration
+ */
 OstreeBootconfigParser *
 ostree_deployment_get_bootconfig (OstreeDeployment *self)
 {
   return self->bootconfig;
 }
 
+/**
+ * ostree_deployment_get_origin:
+ * @self: Deployment
+ *
+ * Returns: (transfer none): Origin
+ */
 GKeyFile *
 ostree_deployment_get_origin (OstreeDeployment *self)
 {
@@ -117,6 +129,12 @@ ostree_deployment_set_origin (OstreeDeployment *self, GKeyFile *origin)
     self->origin = g_key_file_ref (origin);
 }
 
+/**
+ * ostree_deployment_clone:
+ * @self: Deployment
+ *
+ * Returns: (transfer full): New deep copy of @self
+ */
 OstreeDeployment *
 ostree_deployment_clone (OstreeDeployment *self)
 {
diff --git a/src/libostree/ostree-sysroot.c b/src/libostree/ostree-sysroot.c
index e5851ad..df38106 100644
--- a/src/libostree/ostree-sysroot.c
+++ b/src/libostree/ostree-sysroot.c
@@ -1057,6 +1057,8 @@ _ostree_sysroot_kernel_arg_string_serialize (OstreeOrderedHash *ohash)
  *
  * Find the deployment to use as a configuration merge source; this is
  * the first one in the current deployment list which matches osname.
+ *
+ * Returns: (transfer full): Configuration merge deployment
  */
 OstreeDeployment *
 ostree_sysroot_get_merge_deployment (OstreeSysroot     *self,


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]