diff options
author | Alexander Larsson <alexander.larsson@gmail.com> | 2016-05-17 10:17:01 +0200 |
---|---|---|
committer | Alexander Larsson <alexander.larsson@gmail.com> | 2016-05-17 10:17:01 +0200 |
commit | 3b291090c78896b9892b0f38afa9e00d2602c6c3 (patch) | |
tree | 902797ce30e067e1bc417d5ffac1139d153fe5a8 /lib/flatpak-bundle-ref.c | |
parent | b13fc460dfdec9e200272faca3e14977257e2e7a (diff) | |
parent | fab3e4b9918aef256089644b88e4d3e744e04dce (diff) | |
download | xdg-app-3b291090c78896b9892b0f38afa9e00d2602c6c3.tar.gz |
Merge pull request #160 from matthiasclasen/docs
Some library doc updates
Diffstat (limited to 'lib/flatpak-bundle-ref.c')
-rw-r--r-- | lib/flatpak-bundle-ref.c | 28 |
1 files changed, 22 insertions, 6 deletions
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) |