summaryrefslogtreecommitdiff
path: root/common/flatpak-installation.h
diff options
context:
space:
mode:
authorRobert McQueen <rob@endlessm.com>2018-10-01 14:34:22 +0100
committerAtomic Bot <atomic-devel@projectatomic.io>2018-10-01 14:43:09 +0000
commit33cfa59af61fd1b9f0129a936afabab7dd7f35d8 (patch)
treec3e71ce37a40ad805134de15e3ae02e4d70cd9d3 /common/flatpak-installation.h
parent00fcc65157f54dfb6dfd8b0a76c7ce200decef83 (diff)
downloadflatpak-33cfa59af61fd1b9f0129a936afabab7dd7f35d8.tar.gz
installation: tidy doc comments on new API additions
Closes: #2162 Approved by: alexlarsson
Diffstat (limited to 'common/flatpak-installation.h')
-rw-r--r--common/flatpak-installation.h12
1 files changed, 9 insertions, 3 deletions
diff --git a/common/flatpak-installation.h b/common/flatpak-installation.h
index 4bcd1e37..68de2f25 100644
--- a/common/flatpak-installation.h
+++ b/common/flatpak-installation.h
@@ -54,7 +54,9 @@ typedef struct
* @FLATPAK_UPDATE_FLAGS_NO_PULL: Don't try to fetch new builds from the remote repo
* @FLATPAK_UPDATE_FLAGS_NO_STATIC_DELTAS: Don't use static deltas when pulling
* @FLATPAK_UPDATE_FLAGS_NO_PRUNE: Don't prune the local OSTree repository after updating (Since: 0.11.8)
- * @FLATPAK_UPDATE_FLAGS_NO_TRIGGERS: Don't call triggers after updating (Since: 1.0.3)
+ * @FLATPAK_UPDATE_FLAGS_NO_TRIGGERS: Don't call triggers after updating. If used,
+ * the caller must later call @flatpak_installation_run_triggers to update
+ * the exported files. (Since: 1.0.3)
*
* Flags to alter the behavior of flatpak_installation_update().
*/
@@ -73,7 +75,9 @@ typedef enum {
* @FLATPAK_INSTALL_FLAGS_NO_STATIC_DELTAS: Don't use static deltas when pulling
* @FLATPAK_INSTALL_FLAGS_NO_DEPLOY: Don't install any new builds that might be fetched
* @FLATPAK_INSTALL_FLAGS_NO_PULL: Don't try to fetch new builds from the remote repo
- * @FLATPAK_INSTALL_FLAGS_NO_TRIGGERS: Don't call triggers after installing (Since: 1.0.3)
+ * @FLATPAK_INSTALL_FLAGS_NO_TRIGGERS: Don't call triggers after installing. If used,
+ * the caller must later call @flatpak_installation_run_triggers to update
+ * the exported files. (Since: 1.0.3)
*
* Flags to alter the behavior of flatpak_installation_install_full().
*/
@@ -89,7 +93,9 @@ typedef enum {
* FlatpakUninstallFlags:
* @FLATPAK_UNINSTALL_FLAGS_NONE: Default
* @FLATPAK_UNINSTALL_FLAGS_NO_PRUNE: Don't prune the local OSTree repository after uninstalling
- * @FLATPAK_UNINSTALL_FLAGS_NO_TRIGGERS: Don't call triggers after uninstalling (Since: 1.0.3)
+ * @FLATPAK_UNINSTALL_FLAGS_NO_TRIGGERS: Don't call triggers after uninstalling. If used,
+ * the caller must later call @flatpak_installation_run_triggers to update
+ * the exported file. (Since: 1.0.3)
*
* Flags to alter the behavior of flatpak_installation_uninstall_full().
*