diff options
| author | Richard Hughes <richard@hughsie.com> | 2014-03-18 11:20:07 +0000 |
|---|---|---|
| committer | Richard Hughes <richard@hughsie.com> | 2014-03-18 11:21:38 +0000 |
| commit | 3bd7010c35ff0cc7458716a3ec17834fed6a6c57 (patch) | |
| tree | 8db1e136c1053c2ee345c78c72553defb9d7d7c3 /libappstream-glib/as-tag.h | |
| parent | ac87950adcf2c61c927e51439e1201c32213eb39 (diff) | |
| download | appstream-glib-3bd7010c35ff0cc7458716a3ec17834fed6a6c57.tar.gz | |
Add gtk-doc file headers and flesh out the documentation
Diffstat (limited to 'libappstream-glib/as-tag.h')
| -rw-r--r-- | libappstream-glib/as-tag.h | 100 |
1 files changed, 68 insertions, 32 deletions
diff --git a/libappstream-glib/as-tag.h b/libappstream-glib/as-tag.h index 37387c6..99f4533 100644 --- a/libappstream-glib/as-tag.h +++ b/libappstream-glib/as-tag.h @@ -1,6 +1,6 @@ /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- * - * Copyright (C) 2014 Richard Hughes <richard@hughsie.com> + * Copyright (C) 2014 Richard Hughes <richard@hughsie.com` * * Licensed under the GNU Lesser General Public License Version 2.1 * @@ -28,38 +28,74 @@ #include <glib.h> +/** + * AsTag: + * @AS_TAG_UNKNOWN: Type invalid or not known + * @AS_TAG_APPLICATIONS: `applications` + * @AS_TAG_APPLICATION: `application` + * @AS_TAG_ID: `id` + * @AS_TAG_PKGNAME: `pkgname` + * @AS_TAG_NAME: `name` + * @AS_TAG_SUMMARY: `summary` + * @AS_TAG_DESCRIPTION: `description` + * @AS_TAG_URL: `url` + * @AS_TAG_ICON: `icon` + * @AS_TAG_CATEGORIES: `appcategories` + * @AS_TAG_CATEGORY: `appcategory` + * @AS_TAG_KEYWORDS: `keywords` + * @AS_TAG_KEYWORD: `keyword` + * @AS_TAG_MIMETYPES: `mimetypes` + * @AS_TAG_MIMETYPE: `mimetype` + * @AS_TAG_PROJECT_GROUP: `project_group` + * @AS_TAG_PROJECT_LICENSE: `project_license` (or `licence`) + * @AS_TAG_SCREENSHOT: `screenshot` + * @AS_TAG_SCREENSHOTS: `screenshots` + * @AS_TAG_UPDATE_CONTACT: `updatecontact` + * @AS_TAG_IMAGE: `image` + * @AS_TAG_COMPULSORY_FOR_DESKTOP: `compulsory_for_desktop` + * @AS_TAG_PRIORITY: `priority` + * @AS_TAG_CAPTION: `caption` + * @AS_TAG_LANGUAGES: `languages` + * @AS_TAG_LANG: `lang` + * @AS_TAG_METADATA: `metadata` + * @AS_TAG_VALUE: `value` + * @AS_TAG_RELEASES: `releases` + * @AS_TAG_RELEASE: `release` + * + * The tag type. + **/ typedef enum { - AS_TAG_UNKNOWN, - AS_TAG_APPLICATIONS, - AS_TAG_APPLICATION, - AS_TAG_ID, - AS_TAG_PKGNAME, - AS_TAG_NAME, - AS_TAG_SUMMARY, - AS_TAG_DESCRIPTION, - AS_TAG_URL, - AS_TAG_ICON, - AS_TAG_APPCATEGORIES, - AS_TAG_APPCATEGORY, - AS_TAG_KEYWORDS, - AS_TAG_KEYWORD, - AS_TAG_MIMETYPES, - AS_TAG_MIMETYPE, - AS_TAG_PROJECT_GROUP, - AS_TAG_PROJECT_LICENSE, - AS_TAG_SCREENSHOT, - AS_TAG_SCREENSHOTS, - AS_TAG_UPDATECONTACT, - AS_TAG_IMAGE, - AS_TAG_COMPULSORY_FOR_DESKTOP, - AS_TAG_PRIORITY, - AS_TAG_CAPTION, - AS_TAG_LANGUAGES, - AS_TAG_LANG, - AS_TAG_METADATA, - AS_TAG_VALUE, - AS_TAG_RELEASES, - AS_TAG_RELEASE, + AS_TAG_UNKNOWN, /* Since: 0.1.0 */ + AS_TAG_APPLICATIONS, /* Since: 0.1.0 */ + AS_TAG_APPLICATION, /* Since: 0.1.0 */ + AS_TAG_ID, /* Since: 0.1.0 */ + AS_TAG_PKGNAME, /* Since: 0.1.0 */ + AS_TAG_NAME, /* Since: 0.1.0 */ + AS_TAG_SUMMARY, /* Since: 0.1.0 */ + AS_TAG_DESCRIPTION, /* Since: 0.1.0 */ + AS_TAG_URL, /* Since: 0.1.0 */ + AS_TAG_ICON, /* Since: 0.1.0 */ + AS_TAG_CATEGORIES, /* Since: 0.1.0 */ + AS_TAG_CATEGORY, /* Since: 0.1.0 */ + AS_TAG_KEYWORDS, /* Since: 0.1.0 */ + AS_TAG_KEYWORD, /* Since: 0.1.0 */ + AS_TAG_MIMETYPES, /* Since: 0.1.0 */ + AS_TAG_MIMETYPE, /* Since: 0.1.0 */ + AS_TAG_PROJECT_GROUP, /* Since: 0.1.0 */ + AS_TAG_PROJECT_LICENSE, /* Since: 0.1.0 */ + AS_TAG_SCREENSHOT, /* Since: 0.1.0 */ + AS_TAG_SCREENSHOTS, /* Since: 0.1.0 */ + AS_TAG_UPDATE_CONTACT, /* Since: 0.1.0 */ + AS_TAG_IMAGE, /* Since: 0.1.0 */ + AS_TAG_COMPULSORY_FOR_DESKTOP, /* Since: 0.1.0 */ + AS_TAG_PRIORITY, /* Since: 0.1.0 */ + AS_TAG_CAPTION, /* Since: 0.1.0 */ + AS_TAG_LANGUAGES, /* Since: 0.1.0 */ + AS_TAG_LANG, /* Since: 0.1.0 */ + AS_TAG_METADATA, /* Since: 0.1.0 */ + AS_TAG_VALUE, /* Since: 0.1.0 */ + AS_TAG_RELEASES, /* Since: 0.1.0 */ + AS_TAG_RELEASE, /* Since: 0.1.0 */ /*< private >*/ AS_TAG_LAST } AsTag; |