summaryrefslogtreecommitdiff
path: root/libappstream-glib/as-release.c
diff options
context:
space:
mode:
authorRichard Hughes <richard@hughsie.com>2014-03-18 11:20:07 +0000
committerRichard Hughes <richard@hughsie.com>2014-03-18 11:21:38 +0000
commit3bd7010c35ff0cc7458716a3ec17834fed6a6c57 (patch)
tree8db1e136c1053c2ee345c78c72553defb9d7d7c3 /libappstream-glib/as-release.c
parentac87950adcf2c61c927e51439e1201c32213eb39 (diff)
downloadappstream-glib-3bd7010c35ff0cc7458716a3ec17834fed6a6c57.tar.gz
Add gtk-doc file headers and flesh out the documentation
Diffstat (limited to 'libappstream-glib/as-release.c')
-rw-r--r--libappstream-glib/as-release.c16
1 files changed, 16 insertions, 0 deletions
diff --git a/libappstream-glib/as-release.c b/libappstream-glib/as-release.c
index bfb9920..b1bc2c3 100644
--- a/libappstream-glib/as-release.c
+++ b/libappstream-glib/as-release.c
@@ -19,6 +19,22 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
+/**
+ * SECTION:as-release
+ * @short_description: Object representing a single upstream release
+ * @include: appstream-glib.h
+ * @stability: Stable
+ *
+ * This object represents a single upstream release, typically a minor update.
+ * Releases can contain a localized description of paragraph and list elements
+ * and also have a version number and timestamp.
+ *
+ * Releases can be automatically generated by parsing upstream ChangeLogs or
+ * .spec files, or can be populated using AppData files.
+ *
+ * See also: #AsApp
+ */
+
#include "config.h"
#include <stdlib.h>