From 010306e1ad48c66650bff68ec0e4e485f6518a65 Mon Sep 17 00:00:00 2001
From: Vincent Sanders <vince@kyllikki.org>
Date: Fri, 19 Jun 2015 09:07:31 +0100
Subject: Clean up doxygen errors in image handlers.

---
 image/bmp.c | 9 +++++----
 image/gif.c | 8 +++++---
 image/ico.c | 2 +-
 3 files changed, 11 insertions(+), 8 deletions(-)

(limited to 'image')

diff --git a/image/bmp.c b/image/bmp.c
index dfa573fee..7e992ae43 100644
--- a/image/bmp.c
+++ b/image/bmp.c
@@ -34,6 +34,7 @@
 #include "image/bitmap.h"
 #include "image/bmp.h"
 
+/** bmp context. */
 typedef struct nsbmp_content {
 	struct content base;
 
@@ -45,10 +46,10 @@ typedef struct nsbmp_content {
 /**
  * Callback for libnsbmp; forwards the call to bitmap_create()
  *
- * \param  width   width of image in pixels
- * \param  height  width of image in pixels
- * \param  state   a flag word indicating the initial state
- * \return an opaque struct bitmap, or NULL on memory exhaustion
+ * \param width width of image in pixels
+ * \param height width of image in pixels
+ * \param bmp_state A flag word indicating the initial state
+ * \return An opaque struct bitmap, or NULL on memory exhaustion
  */
 static void *nsbmp_bitmap_create(int width, int height, unsigned int bmp_state)
 {
diff --git a/image/gif.c b/image/gif.c
index 871b1cc2c..3f5f6307e 100644
--- a/image/gif.c
+++ b/image/gif.c
@@ -305,7 +305,8 @@ static bool nsgif_convert(struct content *c)
 /**
  * Updates the GIF bitmap to display the current frame
  *
- * \param c  the content to update
+ * \param gif The gif context to update.
+ * \return GIF_OK on success else apropriate error code.
  */
 static gif_result nsgif_get_frame(nsgif_content *gif)
 {
@@ -317,10 +318,11 @@ static gif_result nsgif_get_frame(nsgif_content *gif)
 		current_frame = 0;
 	}
 
-	if (current_frame < gif->gif->decoded_frame)
+	if (current_frame < gif->gif->decoded_frame) {
 		previous_frame = 0;
-	else
+	} else {
 		previous_frame = gif->gif->decoded_frame + 1;
+	}
 
 	for (frame = previous_frame; frame <= current_frame; frame++) {
 		res = gif_decode_frame(gif->gif, frame);
diff --git a/image/ico.c b/image/ico.c
index 9cb650bfe..cf74592a8 100644
--- a/image/ico.c
+++ b/image/ico.c
@@ -45,7 +45,7 @@ typedef struct nsico_content {
  *
  * \param  width   width of image in pixels
  * \param  height  width of image in pixels
- * \param  state   a flag word indicating the initial state
+ * \param  bmp_state A flag word indicating the initial state
  * \return an opaque struct bitmap, or NULL on memory exhaustion
  */
 static void *nsico_bitmap_create(int width, int height, unsigned int bmp_state)
-- 
cgit v1.2.3