Changeset 4669:a539a066ee64 in roaraudio for include/libroar/hash_tiger.h

Timestamp:

12/19/10 19:48:38 (13 years ago)

Author:

phi

Branch:

default

Phase:

public

Message:

some comments

File:

• include/libroar/hash_tiger.h (modified) (1 diff)

include/libroar/hash_tiger.h

@@ -47 +47 @@
 };
 
+// init and deinit functions:
 int roar_hash_tiger_init(struct roar_hash_tiger * state);
 int roar_hash_tiger_uninit(struct roar_hash_tiger * state);
 
+// functions needed for string internal state:
 int roar_hash_tiger_init_from_pstate(struct roar_hash_tiger * state, void * oldstate);
 int roar_hash_tiger_to_pstate(struct roar_hash_tiger * state, void * newstate, size_t * len);
 ssize_t roar_hash_tiger_statelen(struct roar_hash_tiger * state);
 
+// finalize, should not be called directly:
 int roar_hash_tiger_finalize(struct roar_hash_tiger * state);
+
+// finalize and get final digest:
 int roar_hash_tiger_get_digest(struct roar_hash_tiger * state, void * digest, size_t * len);
 
+// optimized functions to process fixed size data blocks:
 int roar_hash_tiger_proc_block(struct roar_hash_tiger * state, void * block);
 ssize_t roar_hash_tiger_blocklen(struct roar_hash_tiger * state);
 
+// normal function to process data:
 int roar_hash_tiger_proc(struct roar_hash_tiger * state, void * data, size_t len);