From d30ef7c60298091c6eccdb0a27ac403cbad781d5 Mon Sep 17 00:00:00 2001
From: Matthias Clasen <mclasen@redhat.com>
Date: Mon, 16 May 2016 19:50:30 -0400
Subject: Document FlatpakBundleRef apis

---
 lib/flatpak-bundle-ref.c | 28 ++++++++++++++++++++++------
 1 file changed, 22 insertions(+), 6 deletions(-)

(limited to 'lib')

diff --git a/lib/flatpak-bundle-ref.c b/lib/flatpak-bundle-ref.c
index ba3955e..cc5c4ca 100644
--- a/lib/flatpak-bundle-ref.c
+++ b/lib/flatpak-bundle-ref.c
@@ -131,7 +131,7 @@ flatpak_bundle_ref_init (FlatpakBundleRef *self)
 
 /**
  * flatpak_bundle_ref_get_file:
- * @self: a #FlatpakInstallation
+ * @self: a #FlatpakBundleRef
  *
  * Get the file this bundle is stored in.
  *
@@ -147,7 +147,7 @@ flatpak_bundle_ref_get_file (FlatpakBundleRef *self)
 
 /**
  * flatpak_bundle_ref_get_metadata:
- * @self: a #FlatpakInstallation
+ * @self: a #FlatpakBundleRef
  *
  * Get the metadata for the app/runtime
  *
@@ -165,7 +165,7 @@ flatpak_bundle_ref_get_metadata (FlatpakBundleRef *self)
 
 /**
  * flatpak_bundle_ref_get_appstream:
- * @self: a #FlatpakInstallation
+ * @self: a #FlatpakBundleRef
  *
  * Get the compressed appstream for the app/runtime
  *
@@ -183,7 +183,7 @@ flatpak_bundle_ref_get_appstream (FlatpakBundleRef *self)
 
 /**
  * flatpak_bundle_ref_get_icon:
- * @self: a #FlatpakInstallation
+ * @self: a #FlatpakBundleRef
  * @size: 64 or 128
  *
  * Get the icon png data for the app/runtime
@@ -207,7 +207,7 @@ flatpak_bundle_ref_get_icon (FlatpakBundleRef *self,
 
 /**
  * flatpak_bundle_ref_get_origin:
- * @self: a #FlatpakInstallation
+ * @self: a #FlatpakBundleRef
  *
  * Get the origin url stored in the bundle
  *
@@ -221,6 +221,14 @@ flatpak_bundle_ref_get_origin (FlatpakBundleRef *self)
   return g_strdup (priv->origin);
 }
 
+/**
+ * flatpak_bundle_ref_get_installed_size:
+ * @self: a FlatpakBundleRef
+ *
+ * Returns the installed size for the bundle.
+ *
+ * Returns: the installed size
+ */
 guint64
 flatpak_bundle_ref_get_installed_size (FlatpakBundleRef *self)
 {
@@ -229,7 +237,15 @@ flatpak_bundle_ref_get_installed_size (FlatpakBundleRef *self)
   return priv->installed_size;
 }
 
-
+/**
+ * flatpak_bundle_ref_new:
+ * @file: a #GFile
+ * @error: (allow-none): return location for an error
+ *
+ * Creates a new bundle ref for the given file.
+ *
+ * Returns: a new bundle ref.
+ */
 FlatpakBundleRef *
 flatpak_bundle_ref_new (GFile   *file,
                         GError **error)
-- 
cgit v1.2.1