summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRichard Hughes <richard@hughsie.com>2015-08-03 13:42:38 +0100
committerRichard Hughes <richard@hughsie.com>2015-08-03 13:42:38 +0100
commit930cda7e590e1bd1a4b44ccc74f39309f3989174 (patch)
tree47ef6b7de11daf883b1e250307a855010401a8ca
parent1caf5938041a187d570687cb6c4213e7762b704c (diff)
downloadappstream-glib-930cda7e590e1bd1a4b44ccc74f39309f3989174.tar.gz
trivial: Add some missing gtk-doc comments
-rw-r--r--libappstream-glib/as-image.h2
-rw-r--r--libappstream-glib/as-monitor.c20
-rw-r--r--libappstream-glib/as-release.c4
-rw-r--r--libappstream-glib/as-utils.h2
4 files changed, 26 insertions, 2 deletions
diff --git a/libappstream-glib/as-image.h b/libappstream-glib/as-image.h
index 498cab1..2032d49 100644
--- a/libappstream-glib/as-image.h
+++ b/libappstream-glib/as-image.h
@@ -80,6 +80,8 @@ typedef enum {
* AsImageSaveFlags:
* @AS_IMAGE_SAVE_FLAG_NONE: No special flags set
* @AS_IMAGE_SAVE_FLAG_PAD_16_9: Pad with alpha to 16:9 aspect
+ * @AS_IMAGE_SAVE_FLAG_SHARPEN: Sharpen the image to clarify detail
+ * @AS_IMAGE_SAVE_FLAG_BLUR: Blur the image to clear detail
*
* The flags used for saving images.
**/
diff --git a/libappstream-glib/as-monitor.c b/libappstream-glib/as-monitor.c
index 3501d62..2582c32 100644
--- a/libappstream-glib/as-monitor.c
+++ b/libappstream-glib/as-monitor.c
@@ -416,6 +416,16 @@ as_monitor_file_changed_cb (GFileMonitor *mon,
/**
* as_monitor_add_directory:
+ * @monitor: an #AsMonitor
+ * @filename: directory name
+ * @cancellable: a #GCancellable or %NULL
+ * @error: a #GError or %NULL
+ *
+ * Adds a directory of files to the watch list.
+ *
+ * Returns: %TRUE for success
+ *
+ * Since: 0.5.0
**/
gboolean
as_monitor_add_directory (AsMonitor *monitor,
@@ -455,6 +465,16 @@ as_monitor_add_directory (AsMonitor *monitor,
/**
* as_monitor_add_file:
+ * @monitor: an #AsMonitor
+ * @filename: a filename
+ * @cancellable: a #GCancellable or %NULL
+ * @error: a #GError or %NULL
+ *
+ * Adds a file to the watch list.
+ *
+ * Returns: %TRUE for success
+ *
+ * Since: 0.5.0
**/
gboolean
as_monitor_add_file (AsMonitor *monitor,
diff --git a/libappstream-glib/as-release.c b/libappstream-glib/as-release.c
index 286bd67..0ca7a11 100644
--- a/libappstream-glib/as-release.c
+++ b/libappstream-glib/as-release.c
@@ -202,7 +202,8 @@ as_release_get_checksums (AsRelease *release)
/**
* as_release_get_checksum_by_fn:
- * @release: a #AsRelease instance.
+ * @release: a #AsRelease instance
+ * @fn: a file basename
*
* Gets the checksum for a release.
*
@@ -227,6 +228,7 @@ as_release_get_checksum_by_fn (AsRelease *release, const gchar *fn)
/**
* as_release_get_checksum_by_target:
+ * @release: a #AsRelease instance
* @target: a #AsChecksumTarget, e.g. %AS_CHECKSUM_TARGET_CONTAINER
*
* Gets the checksum for a release.
diff --git a/libappstream-glib/as-utils.h b/libappstream-glib/as-utils.h
index 79cbab2..7de17fb 100644
--- a/libappstream-glib/as-utils.h
+++ b/libappstream-glib/as-utils.h
@@ -78,7 +78,7 @@ typedef enum {
/**
* AsMarkupConvertFormat:
- * @AS_MARKUP_CONVERT_FORMAT_SIMPLE UTF-8 text
+ * @AS_MARKUP_CONVERT_FORMAT_SIMPLE: UTF-8 text
* @AS_MARKUP_CONVERT_FORMAT_MARKDOWN: Markdown format
*
* The output format used when converting AppStream descriptions.