From 66cdd7b197c5ccca331f470e9750e43f1f5177e4 Mon Sep 17 00:00:00 2001
From: Sam Thursfield <sam.thursfield@codethink.co.uk>
Date: Wed, 27 Jan 2016 18:21:40 +0100
Subject: [PATCH] Document the structs in libxdg-app

---
 doc/reference/xdg-app-docs.xml | 1 +
 lib/xdg-app-error.h            | 4 +++-
 lib/xdg-app-installation.h     | 8 ++++++++
 lib/xdg-app-ref.h              | 9 +++++++++
 4 files changed, 21 insertions(+), 1 deletion(-)

diff --git a/doc/reference/xdg-app-docs.xml b/doc/reference/xdg-app-docs.xml
index e43109dd..01b0c061 100644
--- a/doc/reference/xdg-app-docs.xml
+++ b/doc/reference/xdg-app-docs.xml
@@ -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"/>
diff --git a/lib/xdg-app-error.h b/lib/xdg-app-error.h
index 0aebfb03..b2f371ee 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 de437dda..f45ec6fc 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 6c584272..26f3bc10 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,