Document gdImageCompare()

1 files changed, 13 insertions, 3 deletions

diff --git a/src/gd.c b/src/gd.c
index f7605dc..f0cfacd 100644
--- a/src/gd.c
+++ b/src/gd.c
@@ -3941,9 +3941,19 @@ BGD_DECLARE(void) gdImageInterlace (gdImagePtr im, int interlaceArg)
 	im->interlace = interlaceArg;
 }
 
-/*
-	Function: gdImageCompare
-*/
+/**
+ * Function: gdImageCompare
+ *
+ * Compare two images
+ *
+ * Parameters:
+ *   im1 - An image.
+ *   im2 - Another image.
+ *
+ * Returns:
+ *   A bitmask of <Image Comparison> flags where each set flag signals
+ *   which attributes of the images are different.
+ */
 BGD_DECLARE(int) gdImageCompare (gdImagePtr im1, gdImagePtr im2)
 {
 	int x, y;