diff options
| author | Sam Thursfield <sam.thursfield@codethink.co.uk> | 2016-01-27 18:21:40 +0100 |
|---|---|---|
| committer | Alexander Larsson <alexl@redhat.com> | 2016-01-28 11:26:12 +0100 |
| commit | 66cdd7b197c5ccca331f470e9750e43f1f5177e4 (patch) | |
| tree | c1c5b085be547637125cb8354d1ffcc995395b5b /lib | |
| parent | dcf1df24545d450e52db03a43c92fdacf0b96a6d (diff) | |
| download | xdg-app-66cdd7b197c5ccca331f470e9750e43f1f5177e4.tar.gz | |
Document the structs in libxdg-app
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/xdg-app-error.h | 4 | ||||
| -rw-r--r-- | lib/xdg-app-installation.h | 8 | ||||
| -rw-r--r-- | lib/xdg-app-ref.h | 9 |
3 files changed, 20 insertions, 1 deletions
diff --git a/lib/xdg-app-error.h b/lib/xdg-app-error.h index 0aebfb0..b2f371e 100644 --- a/lib/xdg-app-error.h +++ b/lib/xdg-app-error.h @@ -27,7 +27,9 @@ G_BEGIN_DECLS /** - * XdpErrorEnum: + * XdgAppError: + * @XDG_APP_ERROR_ALREADY_INSTALLED: App/runtime is already installed + * @XDG_APP_ERROR_NOT_INSTALLED: App/runtime is not installed */ typedef enum { XDG_APP_ERROR_ALREADY_INSTALLED, diff --git a/lib/xdg-app-installation.h b/lib/xdg-app-installation.h index de437dd..f45ec6f 100644 --- a/lib/xdg-app-installation.h +++ b/lib/xdg-app-installation.h @@ -45,6 +45,14 @@ typedef struct { GObjectClass parent_class; } XdgAppInstallationClass; +/** + * XdgAppUpdateFlags: + * @XDG_APP_UPDATE_FLAGS_NONE: Fetch remote builds and install the latest one (default) + * @XDG_APP_UPDATE_FLAGS_NO_DEPLOY: Don't install any new builds that might be fetched + * @XDG_APP_UPDATE_FLAGS_NO_PULL: Don't try to fetch new builds from the remote repo + * + * Flags to alter the behavior of xdg_app_installation_update(). + */ typedef enum { XDG_APP_UPDATE_FLAGS_NONE = 0, XDG_APP_UPDATE_FLAGS_NO_DEPLOY = (1<<0), diff --git a/lib/xdg-app-ref.h b/lib/xdg-app-ref.h index 6c58427..26f3bc1 100644 --- a/lib/xdg-app-ref.h +++ b/lib/xdg-app-ref.h @@ -48,6 +48,15 @@ typedef struct { G_DEFINE_AUTOPTR_CLEANUP_FUNC(XdgAppRef, g_object_unref) #endif +/** + * XdgAppRefKind: + * @XDG_APP_REF_KIND_APP: An application + * @XDG_APP_REF_KIND_RUNTIME: A runtime that applications can use. + * + * Currently xdg-app manages two types of binary artifacts: applications, and + * runtimes. Applications contain a program that desktop users can run, while + * runtimes contain only libraries and data. + */ typedef enum { XDG_APP_REF_KIND_APP, XDG_APP_REF_KIND_RUNTIME, |