From 4badb9a89b6059f4476528124b7b401b24942340 Mon Sep 17 00:00:00 2001 From: Michael Jumper Date: Sat, 1 Dec 2012 20:11:14 -0800 Subject: [PATCH] Fix documentation. --- libguac/include/hash.h | 8 +++++++- libguac/include/pool.h | 4 ++-- libguac/include/stream.h | 2 +- libguac/include/unicode.h | 6 ++++++ 4 files changed, 16 insertions(+), 4 deletions(-) diff --git a/libguac/include/hash.h b/libguac/include/hash.h index 312a05f1..d181e357 100644 --- a/libguac/include/hash.h +++ b/libguac/include/hash.h @@ -35,12 +35,18 @@ * * ***** END LICENSE BLOCK ***** */ - #ifndef _GUAC_HASH_H #define _GUAC_HASH_H #include +/** + * Provides functions and structures for producing likely-to-be-unique hash + * values for images. + * + * @file hash.h + */ + /** * Produces a 24-bit hash value from all pixels of the given surface. The * surface provided must be RGB or ARGB with each pixel stored in 32 bits. diff --git a/libguac/include/pool.h b/libguac/include/pool.h index a88ccdd0..629d863b 100644 --- a/libguac/include/pool.h +++ b/libguac/include/pool.h @@ -39,8 +39,8 @@ #define _GUAC_POOL_H /** - * Provides functions and structures for maintaining dynamically allocated and freed - * pools of integers. + * Provides functions and structures for maintaining dynamically allocated and + * freed pools of integers. * * @file pool.h */ diff --git a/libguac/include/stream.h b/libguac/include/stream.h index 06dc7b45..fa0bb089 100644 --- a/libguac/include/stream.h +++ b/libguac/include/stream.h @@ -42,7 +42,7 @@ * Provides functions and structures required for allocating and using nested * streams. * - * @file layer.h + * @file stream.h */ typedef struct guac_stream guac_stream; diff --git a/libguac/include/unicode.h b/libguac/include/unicode.h index 3364641e..cace74e2 100644 --- a/libguac/include/unicode.h +++ b/libguac/include/unicode.h @@ -40,6 +40,12 @@ #include +/** + * Provides functions for manipulating Unicode strings. + * + * @file unicode.h + */ + /** * Given the initial byte of a single UTF-8 character, returns the overall * byte size of the entire character.