summaryrefslogtreecommitdiff
path: root/libappstream-glib/as-screenshot.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-screenshot.c
parentac87950adcf2c61c927e51439e1201c32213eb39 (diff)
downloadappstream-glib-3bd7010c35ff0cc7458716a3ec17834fed6a6c57.tar.gz
Add gtk-doc file headers and flesh out the documentation
Diffstat (limited to 'libappstream-glib/as-screenshot.c')
-rw-r--r--libappstream-glib/as-screenshot.c12
1 files changed, 12 insertions, 0 deletions
diff --git a/libappstream-glib/as-screenshot.c b/libappstream-glib/as-screenshot.c
index 258d56c..9ee31f5 100644
--- a/libappstream-glib/as-screenshot.c
+++ b/libappstream-glib/as-screenshot.c
@@ -19,6 +19,18 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
+/**
+ * SECTION:as-screenshot
+ * @short_description: Object representing a single screenshot
+ * @include: appstream-glib.h
+ * @stability: Stable
+ *
+ * Screenshots have a localized caption and also contain a number of images
+ * of different resolution.
+ *
+ * See also: #AsImage
+ */
+
#include "config.h"
#include "as-image-private.h"