diff options
author | Campbell Barton <ideasman42@gmail.com> | 2013-08-25 20:28:48 +0400 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2013-08-25 20:28:48 +0400 |
commit | df01ad250edf76c72f5c5cd9e6e779970352e4a6 (patch) | |
tree | e2b6a3bdf637deffbf9c452f50bfb3278fa10ef0 /source/blender/blenlib/BLI_ghash.h | |
parent | e2bd3a4644aa0317356e801df1a2fda1d998df43 (diff) |
move doxy docs out of the ghash header into the C file.
Diffstat (limited to 'source/blender/blenlib/BLI_ghash.h')
-rw-r--r-- | source/blender/blenlib/BLI_ghash.h | 61 |
1 files changed, 8 insertions, 53 deletions
diff --git a/source/blender/blenlib/BLI_ghash.h b/source/blender/blenlib/BLI_ghash.h index 1a43e95216a..0e06cd64e95 100644 --- a/source/blender/blenlib/BLI_ghash.h +++ b/source/blender/blenlib/BLI_ghash.h @@ -78,61 +78,16 @@ void BLI_ghash_flag_clear(GHash *gh, unsigned int flag); /* *** */ -/** - * Create a new GHashIterator. The hash table must not be mutated - * while the iterator is in use, and the iterator will step exactly - * BLI_ghash_size(gh) times before becoming done. - * - * \param gh The GHash to iterate over. - * \return Pointer to a new DynStr. - */ GHashIterator *BLI_ghashIterator_new(GHash *gh); -/** - * Init an already allocated GHashIterator. The hash table must not - * be mutated while the iterator is in use, and the iterator will - * step exactly BLI_ghash_size(gh) times before becoming done. - * - * \param ghi The GHashIterator to initialize. - * \param gh The GHash to iterate over. - */ -void BLI_ghashIterator_init(GHashIterator *ghi, GHash *gh); -/** - * Free a GHashIterator. - * - * \param ghi The iterator to free. - */ -void BLI_ghashIterator_free(GHashIterator *ghi); -/** - * Retrieve the key from an iterator. - * - * \param ghi The iterator. - * \return The key at the current index, or NULL if the - * iterator is done. - */ -void *BLI_ghashIterator_getKey(GHashIterator *ghi); -/** - * Retrieve the value from an iterator. - * - * \param ghi The iterator. - * \return The value at the current index, or NULL if the - * iterator is done. - */ -void *BLI_ghashIterator_getValue(GHashIterator *ghi); -/** - * Steps the iterator to the next index. - * - * \param ghi The iterator. - */ -void BLI_ghashIterator_step(GHashIterator *ghi); -/** - * Determine if an iterator is done (has reached the end of - * the hash table). - * - * \param ghi The iterator. - * \return True if done, False otherwise. - */ -bool BLI_ghashIterator_done(GHashIterator *ghi); +void BLI_ghashIterator_init(GHashIterator *ghi, GHash *gh); +void BLI_ghashIterator_free(GHashIterator *ghi); + +void *BLI_ghashIterator_getKey(GHashIterator *ghi); +void *BLI_ghashIterator_getValue(GHashIterator *ghi); + +void BLI_ghashIterator_step(GHashIterator *ghi); +bool BLI_ghashIterator_done(GHashIterator *ghi); #define GHASH_ITER(gh_iter_, ghash_) \ for (BLI_ghashIterator_init(&gh_iter_, ghash_); \ |