Fix comment.

This commit is contained in:
Ilmir Usmanov 2014-12-12 15:28:56 +03:00
parent ddac13f944
commit 864bd3de06

View File

@ -14,14 +14,13 @@
*/ */
/** /**
This file contains macros to create and manipulate hash-tables. This file contains functions to create and manipulate hash-tables.
In order to define a hash use HASH_TABLE or STATIC_HASH_TABLE macro. Before using the hash initialize it by calling hash_table_init function.
DO NOT FORGET to define KEY_TYPE##_hash and KEY_TYPE##_equal functions, they will be used The function takes pointer to hash function as the last parameter.
for internal purposes. URGENT: the result of the hash function must not be greater than size of the hash table.
Before using the hash initialize it by calling HASH_INIT macro. To insert a key-value pair, use hash_table_insert function.
To insert a key-value pair, use HASH_INSERT macro. To lookup a value by the key, use hash_table_lookup function.
To lookup a value by the key, use HASH_LOOKUP macro. After using the hash, delete it by calling hash_table_free function.
After using the hash, delete it by calling HASH_FREE macro.
*/ */
#ifndef HASH_TABLE_H #ifndef HASH_TABLE_H
#define HASH_TABLE_H #define HASH_TABLE_H