From eff8cc9cccdaa7248d9d869473704e9db69c2f41 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Sun, 14 Apr 2019 10:48:42 +0200 Subject: Cleanup: doxy comments Use doxy references to function and enums, also correct some names which became out of sync. --- source/blender/blenlib/intern/BLI_ghash.c | 4 ++-- source/blender/blenlib/intern/edgehash.c | 2 +- source/blender/blenlib/intern/math_matrix.c | 14 +++++++------- source/blender/blenlib/intern/winstuff_dir.c | 7 ++++--- 4 files changed, 14 insertions(+), 13 deletions(-) (limited to 'source/blender/blenlib/intern') diff --git a/source/blender/blenlib/intern/BLI_ghash.c b/source/blender/blenlib/intern/BLI_ghash.c index af3a7a4f68a..ae1c6e0ba0b 100644 --- a/source/blender/blenlib/intern/BLI_ghash.c +++ b/source/blender/blenlib/intern/BLI_ghash.c @@ -1045,7 +1045,7 @@ void BLI_ghash_flag_clear(GHash *gh, uint 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_len(gh) times before becoming done. + * #BLI_ghash_len(gh) times before becoming done. * * \param gh: The GHash to iterate over. * \return Pointer to a new DynStr. @@ -1060,7 +1060,7 @@ 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_len(gh) times before becoming done. + * step exactly #BLI_ghash_len(gh) times before becoming done. * * \param ghi: The GHashIterator to initialize. * \param gh: The GHash to iterate over. diff --git a/source/blender/blenlib/intern/edgehash.c b/source/blender/blenlib/intern/edgehash.c index 55c9a189a20..564090f734e 100644 --- a/source/blender/blenlib/intern/edgehash.c +++ b/source/blender/blenlib/intern/edgehash.c @@ -314,7 +314,7 @@ void *BLI_edgehash_lookup_default(EdgeHash *eh, uint v0, uint v1, void *default_ * Return value for given edge (\a v0, \a v1), or NULL if * if key does not exist in hash. (If need exists * to differentiate between key-value being NULL and - * lack of key then see BLI_edgehash_lookup_p(). + * lack of key then see #BLI_edgehash_lookup_p(). */ void *BLI_edgehash_lookup(EdgeHash *eh, uint v0, uint v1) { diff --git a/source/blender/blenlib/intern/math_matrix.c b/source/blender/blenlib/intern/math_matrix.c index f21d883252c..d750ae4ce59 100644 --- a/source/blender/blenlib/intern/math_matrix.c +++ b/source/blender/blenlib/intern/math_matrix.c @@ -2555,20 +2555,20 @@ void invert_m4_m4_safe(float Ainv[4][4], const float A[4][4]) } /** - * SpaceTransform struct encapsulates all needed data to convert between two coordinate spaces + * #SpaceTransform struct encapsulates all needed data to convert between two coordinate spaces * (where conversion can be represented by a matrix multiplication). * * A SpaceTransform is initialized using: - * BLI_SPACE_TRANSFORM_SETUP(&data, ob1, ob2) + * - #BLI_SPACE_TRANSFORM_SETUP(&data, ob1, ob2) * * After that the following calls can be used: - * BLI_space_transform_apply(&data, co); // converts a coordinate in ob1 space to the corresponding ob2 space - * BLI_space_transform_invert(&data, co); // converts a coordinate in ob2 space to the corresponding ob1 space + * - #BLI_space_transform_apply(&data, co); // converts a coordinate in ob1 space to the corresponding ob2 space. + * - #BLI_space_transform_invert(&data, co); // converts a coordinate in ob2 space to the corresponding ob1 space. * - * Same concept as BLI_space_transform_apply and BLI_space_transform_invert, but no is normalized after conversion + * Same concept as #BLI_space_transform_apply and #BLI_space_transform_invert, but no is normalized after conversion * (and not translated at all!): - * BLI_space_transform_apply_normal(&data, no); - * BLI_space_transform_invert_normal(&data, no); + * - #BLI_space_transform_apply_normal(&data, no); + * - #BLI_space_transform_invert_normal(&data, no); */ /** diff --git a/source/blender/blenlib/intern/winstuff_dir.c b/source/blender/blenlib/intern/winstuff_dir.c index b302eaea9de..9c1a51f9be7 100644 --- a/source/blender/blenlib/intern/winstuff_dir.c +++ b/source/blender/blenlib/intern/winstuff_dir.c @@ -54,9 +54,10 @@ struct __dirstream { struct dirent direntry; }; -/* Note: MinGW (FREE_WINDOWS) has opendir() and _wopendir(), and only the - * latter accepts a path name of wchar_t type. Rather than messing up with - * extra #ifdef's here and there, Blender's own implementations of opendir() +/** + * \note MinGW (FREE_WINDOWS) has #opendir() and #_wopendir(), and only the + * latter accepts a path name of #wchar_t type. Rather than messing up with + * extra #ifdef's here and there, Blender's own implementations of #opendir() * and related functions are used to properly support paths with non-ASCII * characters. (kjym3) */ -- cgit v1.2.3