Fix documentation.

This commit is contained in:
Michael Jumper 2012-12-01 20:11:14 -08:00
parent ce32b03171
commit 4badb9a89b
4 changed files with 16 additions and 4 deletions

View File

@ -35,12 +35,18 @@
*
* ***** END LICENSE BLOCK ***** */
#ifndef _GUAC_HASH_H
#define _GUAC_HASH_H
#include <cairo/cairo.h>
/**
* 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.

View File

@ -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
*/

View File

@ -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;

View File

@ -40,6 +40,12 @@
#include <stddef.h>
/**
* 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.