summaryrefslogtreecommitdiff
path: root/src/cairo-hash.c
diff options
context:
space:
mode:
authorBehdad Esfahbod <behdad@behdad.org>2008-01-28 20:48:48 -0500
committerBehdad Esfahbod <behdad@behdad.org>2008-01-28 20:48:48 -0500
commit9ecde82d35ead4975ce110bb2012264e3ca9d2e1 (patch)
tree319367b5d3ea15e10f3e12090ccb1134d0cf53c8 /src/cairo-hash.c
parent099c3c2602b59fbf9424044caa1fec7eb92f71df (diff)
downloadcairo-9ecde82d35ead4975ce110bb2012264e3ca9d2e1.tar.gz
[doc] Make sure all macro names in docs are prefixed by %
Diffstat (limited to 'src/cairo-hash.c')
-rw-r--r--src/cairo-hash.c36
1 files changed, 18 insertions, 18 deletions
diff --git a/src/cairo-hash.c b/src/cairo-hash.c
index c419e9e06..8075ac440 100644
--- a/src/cairo-hash.c
+++ b/src/cairo-hash.c
@@ -42,14 +42,14 @@
* An entry can be in one of three states:
*
* FREE: Entry has never been used, terminates all searches.
- * Appears in the table as a NULL pointer.
+ * Appears in the table as a %NULL pointer.
*
* DEAD: Entry had been live in the past. A dead entry can be reused
* but does not terminate a search for an exact entry.
* Appears in the table as a pointer to DEAD_ENTRY.
*
* LIVE: Entry is currently being used.
- * Appears in the table as any non-NULL, non-DEAD_ENTRY pointer.
+ * Appears in the table as any non-%NULL, non-DEAD_ENTRY pointer.
*/
static cairo_hash_entry_t dead_entry = { 0 };
@@ -129,7 +129,7 @@ struct _cairo_hash_table {
/**
* _cairo_hash_table_create:
- * @keys_equal: a function to return TRUE if two keys are equal
+ * @keys_equal: a function to return %TRUE if two keys are equal
*
* Creates a new hash table which will use the keys_equal() function
* to compare hash keys. Data is provided to the hash table in the
@@ -141,7 +141,7 @@ struct _cairo_hash_table {
*
* See #cairo_hash_entry_t for more details.
*
- * Return value: the new hash table or NULL if out of memory.
+ * Return value: the new hash table or %NULL if out of memory.
**/
cairo_hash_table_t *
_cairo_hash_table_create (cairo_hash_keys_equal_func_t keys_equal)
@@ -212,9 +212,9 @@ _cairo_hash_table_destroy (cairo_hash_table_t *hash_table)
* @hash_table: a #cairo_hash_table_t to search
* @key: the key to search on
* @hash_code: the hash_code for @key
- * @key_unique: If TRUE, then caller asserts that no key already
+ * @key_unique: If %TRUE, then caller asserts that no key already
* exists that will compare equal to #key, so search can be
- * optimized. If unsure, set to FALSE and the code will always work.
+ * optimized. If unsure, set to %FALSE and the code will always work.
*
* Search the hashtable for a live entry for which
* hash_table->keys_equal returns true. If no such entry exists then
@@ -295,7 +295,7 @@ _cairo_hash_table_lookup_internal (cairo_hash_table_t *hash_table,
* bigger or smaller than the ideal number of entries for the current
* size.
*
- * Return value: CAIRO_STATUS_SUCCESS if successful or
+ * Return value: %CAIRO_STATUS_SUCCESS if successful or
* CAIRO_STATUS_NO_MEMORY if out of memory.
**/
static cairo_status_t
@@ -361,9 +361,9 @@ _cairo_hash_table_resize (cairo_hash_table_t *hash_table)
* key that matches @key, (as determined by the keys_equal() function
* passed to _cairo_hash_table_create).
*
- * Return value: TRUE if there is an entry in the hash table that
- * matches the given key, (which will now be in *entry_return). FALSE
- * otherwise, (in which case *entry_return will be NULL).
+ * Return value: %TRUE if there is an entry in the hash table that
+ * matches the given key, (which will now be in *entry_return). %FALSE
+ * otherwise, (in which case *entry_return will be %NULL).
**/
cairo_bool_t
_cairo_hash_table_lookup (cairo_hash_table_t *hash_table,
@@ -386,22 +386,22 @@ _cairo_hash_table_lookup (cairo_hash_table_t *hash_table,
/**
* _cairo_hash_table_random_entry:
* @hash_table: a hash table
- * @predicate: a predicate function, or NULL for any entry.
+ * @predicate: a predicate function, or %NULL for any entry.
*
* Find a random entry in the hash table satisfying the given
- * @predicate. A NULL @predicate is taken as equivalent to a function
- * which always returns TRUE, (eg. any entry in the table will do).
+ * @predicate. A %NULL @predicate is taken as equivalent to a function
+ * which always returns %TRUE, (eg. any entry in the table will do).
*
* We use the same algorithm as the lookup algorithm to walk over the
* entries in the hash table in a pseudo-random order. Walking
* linearly would favor entries following gaps in the hash table. We
* could also call rand() repeatedly, which works well for almost-full
* tables, but degrades when the table is almost empty, or predicate
- * returns TRUE for most entries.
+ * returns %TRUE for most entries.
*
- * Return value: a random live entry or NULL if there are no entries
+ * Return value: a random live entry or %NULL if there are no entries
* that match the given predicate. In particular, if predicate is
- * NULL, a NULL return value indicates that the table is empty.
+ * NULL, a %NULL return value indicates that the table is empty.
**/
void *
_cairo_hash_table_random_entry (cairo_hash_table_t *hash_table,
@@ -458,7 +458,7 @@ _cairo_hash_table_random_entry (cairo_hash_table_t *hash_table,
* the entry obtained with _cairo_hash_table_lookup. Or if absolutely
* necessary, use _cairo_hash_table_remove first.
*
- * Return value: CAIRO_STATUS_SUCCESS if successful or
+ * Return value: %CAIRO_STATUS_SUCCESS if successful or
* CAIRO_STATUS_NO_MEMORY if insufficient memory is available.
**/
cairo_status_t
@@ -503,7 +503,7 @@ _cairo_hash_table_insert (cairo_hash_table_t *hash_table,
* @key, if any (as determined by the keys_equal() function passed to
* _cairo_hash_table_create).
*
- * Return value: CAIRO_STATUS_SUCCESS if successful or
+ * Return value: %CAIRO_STATUS_SUCCESS if successful or
* CAIRO_STATUS_NO_MEMORY if out of memory.
**/
void