Merge pull request #160 from matthiasclasen/docs

Some library doc updates

5 files changed, 81 insertions, 8 deletions

diff --git a/doc/reference/flatpak-docs.xml b/doc/reference/flatpak-docs.xml
index ce7ae49..d74a6fb 100644
--- a/doc/reference/flatpak-docs.xml
+++ b/doc/reference/flatpak-docs.xml
@@ -20,6 +20,7 @@
     <xi:include href="xml/flatpak-installed-ref.xml"/>
     <xi:include href="xml/flatpak-remote-ref.xml"/>
     <xi:include href="xml/flatpak-remote.xml"/>
+    <xi:include href="xml/flatpak-bundle-ref.xml"/>
     <xi:include href="xml/flatpak-error.xml"/>
     <xi:include href="xml/flatpak-version-macros.xml"/>
   </chapter>
diff --git a/doc/reference/flatpak-sections.txt b/doc/reference/flatpak-sections.txt
index ebe1bd7..0f117e3 100644
--- a/doc/reference/flatpak-sections.txt
+++ b/doc/reference/flatpak-sections.txt
@@ -19,12 +19,17 @@ flatpak_installation_list_installed_refs_by_kind
 flatpak_installation_list_installed_refs_for_update
 flatpak_installation_list_remote_refs_sync
 flatpak_installation_list_remotes
+flatpak_installation_get_remote_by_name
 flatpak_installation_fetch_remote_metadata_sync
 flatpak_installation_fetch_remote_ref_sync
 flatpak_installation_fetch_remote_size_sync
 flatpak_installation_load_app_overrides
 flatpak_installation_update_appstream_sync
 flatpak_installation_install_bundle
+flatpak_installation_drop_caches
+flatpak_installation_modify_remote
+flatpak_installation_remove_remote
+flatpak_get_default_arch
 FlatpakProgressCallback
 FlatpakUpdateFlags
 <SUBSECTION Standard>
@@ -45,6 +50,7 @@ flatpak_installed_ref_get_is_current
 flatpak_installed_ref_get_latest_commit
 flatpak_installed_ref_get_origin
 flatpak_installed_ref_load_metadata
+flatpak_installed_ref_get_subpaths
 <SUBSECTION Standard>
 FlatpakInstalledRefClass
 FLATPAK_INSTALLED_REF
@@ -90,14 +96,23 @@ flatpak_ref_get_type
 <FILE>flatpak-remote</FILE>
 <TITLE>FlatpakRemote</TITLE>
 FlatpakRemote
+flatpak_remote_new
+flatpak_remote_get_name
 flatpak_remote_get_appstream_dir
 flatpak_remote_get_appstream_timestamp
 flatpak_remote_get_gpg_verify
-flatpak_remote_get_name
+flatpak_remote_set_gpg_verify
+flatpak_remote_set_gpg_key
 flatpak_remote_get_noenumerate
+flatpak_remote_set_noenumerate
 flatpak_remote_get_prio
+flatpak_remote_set_prio
 flatpak_remote_get_title
+flatpak_remote_set_title
 flatpak_remote_get_url
+flatpak_remote_set_url
+flatpak_remote_get_disabled
+flatpak_remote_set_disabled
 <SUBSECTION Standard>
 FlatpakRemoteClass
 FLATPAK_IS_REMOTE
@@ -120,3 +135,21 @@ FLATPAK_ERROR
 FlatpakError
 flatpak_error_quark
 </SECTION>
+
+<SECTION>
+<FILE>flatpak-bundle-ref</FILE>
+FlatpakBundleRef
+flatpak_bundle_ref_new
+flatpak_bundle_ref_get_file
+flatpak_bundle_ref_get_metadata
+flatpak_bundle_ref_get_appstream
+flatpak_bundle_ref_get_icon
+flatpak_bundle_ref_get_origin
+flatpak_bundle_ref_get_installed_size
+<SUBSECTION Standard>
+FlatpakBundleRefClass
+FLATPAK_TYPE_BUNDLE_REF
+FLATPAK_BUNDLE_REF
+FLATPAK_IS_BUNDLE_REF
+flatpak_bundle_ref_get_type
+</SECTION>
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)
diff --git a/lib/flatpak-installation.c b/lib/flatpak-installation.c
index bef2381..9c1b4c3 100644
--- a/lib/flatpak-installation.c
+++ b/lib/flatpak-installation.c
@@ -228,6 +228,7 @@ flatpak_installation_get_dir (FlatpakInstallation *self)
 
 /**
  * flatpak_installation_drop_caches:
+ * @self: a #FlatpakInstallation
  * @cancellable: (nullable): a #GCancellable
  * @error: return location for a #GError
  *
@@ -710,6 +711,17 @@ flatpak_installation_list_remotes (FlatpakInstallation *self,
   return g_steal_pointer (&remotes);
 }
 
+/**
+ * flatpak_installation_modify_remote:
+ * @self: a #FlatpakInstallation
+ * @remote: the modified #FlatpakRemote
+ * @cancellable: (nullable): a #GCancellable
+ * @error: return location for a #GError
+ *
+ * Saves changes in the @remote object.
+ *
+ * Returns: %TRUE if the modifications have been committed successfully
+ */
 gboolean
 flatpak_installation_modify_remote (FlatpakInstallation *self,
                                     FlatpakRemote       *remote,
@@ -734,6 +746,17 @@ flatpak_installation_modify_remote (FlatpakInstallation *self,
   return TRUE;
 }
 
+/**
+ * flatpak_installation_remove_remote:
+ * @self: a #FlatpakInstallation
+ * @name: the name of the remote to remove
+ * @cancellable: (nullable): a #GCancellable
+ * @error: return location for a #GError
+ *
+ * Removes the remote with the given name from the installation.
+ *
+ * Returns: %TRUE if the remote has been removed successfully
+ */
 gboolean
 flatpak_installation_remove_remote (FlatpakInstallation *self,
                                     const char          *name,
diff --git a/lib/flatpak-remote.c b/lib/flatpak-remote.c
index 13cb37f..08f2dc3 100644
--- a/lib/flatpak-remote.c
+++ b/lib/flatpak-remote.c
@@ -371,7 +371,7 @@ flatpak_remote_set_noenumerate (FlatpakRemote *self,
 }
 
 /**
- * flatpak_remote_get_disable:
+ * flatpak_remote_get_disabled:
  * @self: a #FlatpakRemote
  *
  * Returns whether this remote is disabled.