From e757c4a3bec8b0e8d198531a28327332af00a9ba Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Wed, 12 Dec 2018 12:50:58 +1100 Subject: Cleanup: use colon separator after parameter Helps separate variable names from descriptive text. Was already used in some parts of the code, double space and dashes were used elsewhere. --- source/blender/blenlib/intern/BLI_ghash.c | 52 +++++++++++++++---------------- 1 file changed, 26 insertions(+), 26 deletions(-) (limited to 'source/blender/blenlib/intern/BLI_ghash.c') diff --git a/source/blender/blenlib/intern/BLI_ghash.c b/source/blender/blenlib/intern/BLI_ghash.c index ec75c140159..edc6286118d 100644 --- a/source/blender/blenlib/intern/BLI_ghash.c +++ b/source/blender/blenlib/intern/BLI_ghash.c @@ -700,10 +700,10 @@ static GHash *ghash_copy(GHash *gh, GHashKeyCopyFP keycopyfp, GHashValCopyFP val /** * Creates a new, empty GHash. * - * \param hashfp Hash callback. - * \param cmpfp Comparison callback. - * \param info Identifier string for the GHash. - * \param nentries_reserve Optionally reserve the number of members that the hash will hold. + * \param hashfp: Hash callback. + * \param cmpfp: Comparison callback. + * \param info: Identifier string for the GHash. + * \param nentries_reserve: Optionally reserve the number of members that the hash will hold. * Use this to avoid resizing buckets if the size is known or can be closely approximated. * \return An empty GHash. */ @@ -796,7 +796,7 @@ void *BLI_ghash_replace_key(GHash *gh, void *key) /** * Lookup the value of \a key in \a gh. * - * \param key The key to lookup. + * \param key: The key to lookup. * \returns the value for \a key or NULL. * * \note When NULL is a valid value, use #BLI_ghash_lookup_p to differentiate a missing key @@ -822,7 +822,7 @@ void *BLI_ghash_lookup_default(GHash *gh, const void *key, void *val_default) /** * Lookup a pointer to the value of \a key in \a gh. * - * \param key The key to lookup. + * \param key: The key to lookup. * \returns the pointer to value for \a key or NULL. * * \note This has 2 main benefits over #BLI_ghash_lookup. @@ -895,9 +895,9 @@ bool BLI_ghash_ensure_p_ex( /** * Remove \a key from \a gh, or return false if the key wasn't found. * - * \param key The key to remove. - * \param keyfreefp Optional callback to free the key. - * \param valfreefp Optional callback to free the value. + * \param key: The key to remove. + * \param keyfreefp: Optional callback to free the key. + * \param valfreefp: Optional callback to free the value. * \return true if \a key was removed from \a gh. */ bool BLI_ghash_remove(GHash *gh, const void *key, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfreefp) @@ -919,8 +919,8 @@ bool BLI_ghash_remove(GHash *gh, const void *key, GHashKeyFreeFP keyfreefp, GHas /** * Remove \a key from \a gh, returning the value or NULL if the key wasn't found. * - * \param key The key to remove. - * \param keyfreefp Optional callback to free the key. + * \param key: The key to remove. + * \param keyfreefp: Optional callback to free the key. * \return the value of \a key int \a gh or NULL. */ void *BLI_ghash_popkey(GHash *gh, const void *key, GHashKeyFreeFP keyfreefp) @@ -979,9 +979,9 @@ bool BLI_ghash_pop( /** * Reset \a gh clearing all entries. * - * \param keyfreefp Optional callback to free the key. - * \param valfreefp Optional callback to free the value. - * \param nentries_reserve Optionally reserve the number of members that the hash will hold. + * \param keyfreefp: Optional callback to free the key. + * \param valfreefp: Optional callback to free the value. + * \param nentries_reserve: Optionally reserve the number of members that the hash will hold. */ void BLI_ghash_clear_ex( GHash *gh, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfreefp, @@ -1005,9 +1005,9 @@ void BLI_ghash_clear(GHash *gh, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfree /** * Frees the GHash and its members. * - * \param gh The GHash to free. - * \param keyfreefp Optional callback to free the key. - * \param valfreefp Optional callback to free the value. + * \param gh: The GHash to free. + * \param keyfreefp: Optional callback to free the key. + * \param valfreefp: Optional callback to free the value. */ void BLI_ghash_free(GHash *gh, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfreefp) { @@ -1047,7 +1047,7 @@ void BLI_ghash_flag_clear(GHash *gh, uint flag) * while the iterator is in use, and the iterator will step exactly * BLI_ghash_len(gh) times before becoming done. * - * \param gh The GHash to iterate over. + * \param gh: The GHash to iterate over. * \return Pointer to a new DynStr. */ GHashIterator *BLI_ghashIterator_new(GHash *gh) @@ -1062,8 +1062,8 @@ GHashIterator *BLI_ghashIterator_new(GHash *gh) * be mutated while the iterator is in use, and the iterator will * step exactly BLI_ghash_len(gh) times before becoming done. * - * \param ghi The GHashIterator to initialize. - * \param gh The GHash to iterate over. + * \param ghi: The GHashIterator to initialize. + * \param gh: The GHash to iterate over. */ void BLI_ghashIterator_init(GHashIterator *ghi, GHash *gh) { @@ -1083,7 +1083,7 @@ void BLI_ghashIterator_init(GHashIterator *ghi, GHash *gh) /** * Steps the iterator to the next index. * - * \param ghi The iterator. + * \param ghi: The iterator. */ void BLI_ghashIterator_step(GHashIterator *ghi) { @@ -1101,7 +1101,7 @@ void BLI_ghashIterator_step(GHashIterator *ghi) /** * Free a GHashIterator. * - * \param ghi The iterator to free. + * \param ghi: The iterator to free. */ void BLI_ghashIterator_free(GHashIterator *ghi) { @@ -1113,7 +1113,7 @@ void BLI_ghashIterator_free(GHashIterator *ghi) /** * Retrieve the key from an iterator. * - * \param ghi The iterator. + * \param ghi: The iterator. * \return The key at the current index, or NULL if the * iterator is done. */ @@ -1125,7 +1125,7 @@ void *BLI_ghashIterator_getKey(GHashIterator *ghi) /** * Retrieve the value from an iterator. * - * \param ghi The iterator. + * \param ghi: The iterator. * \return The value at the current index, or NULL if the * iterator is done. */ @@ -1137,7 +1137,7 @@ void *BLI_ghashIterator_getValue(GHashIterator *ghi) /** * Retrieve the value from an iterator. * - * \param ghi The iterator. + * \param ghi: The iterator. * \return The value at the current index, or NULL if the * iterator is done. */ @@ -1150,7 +1150,7 @@ void **BLI_ghashIterator_getValue_p(GHashIterator *ghi) * Determine if an iterator is done (has reached the end of * the hash table). * - * \param ghi The iterator. + * \param ghi: The iterator. * \return True if done, False otherwise. */ bool BLI_ghashIterator_done(GHashIterator *ghi) -- cgit v1.2.3