Document the structs in libxdg-app

tingping/wmclass
Sam Thursfield 2016-01-27 18:21:40 +01:00 committed by Alexander Larsson
parent dcf1df2454
commit 66cdd7b197
4 changed files with 21 additions and 1 deletions

View File

@ -14,6 +14,7 @@
<chapter>
<title>XDG-App</title>
<xi:include href="xml/xdg-app-error.xml"/>
<xi:include href="xml/xdg-app-installation.xml"/>
<xi:include href="xml/xdg-app-installed-ref.xml"/>
<xi:include href="xml/xdg-app-remote-ref.xml"/>

View File

@ -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,

View File

@ -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),

View File

@ -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,