From 48881ad1e05fffea39091b5d38917c880e8abd4c Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Wed, 14 May 2014 15:00:47 +1000 Subject: Code cleanup: doxy comments --- source/blender/blenlib/intern/BLI_ghash.c | 2 +- source/blender/blenlib/intern/math_rotation.c | 4 ++-- source/blender/blenlib/intern/path_util.c | 2 -- source/blender/blenlib/intern/polyfill2d.c | 3 ++- source/blender/blenlib/intern/timecode.c | 2 +- 5 files changed, 6 insertions(+), 7 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 7b48744bcdf..e55f20e99eb 100644 --- a/source/blender/blenlib/intern/BLI_ghash.c +++ b/source/blender/blenlib/intern/BLI_ghash.c @@ -742,7 +742,7 @@ int BLI_ghashutil_intcmp(const void *a, const void *b) * This function implements the widely used "djb" hash apparently posted * by Daniel Bernstein to comp.lang.c some time ago. The 32 bit * unsigned hash value starts at 5381 and for each byte 'c' in the - * string, is updated: hash = hash * 33 + c. This + * string, is updated: ``hash = hash * 33 + c``. This * function uses the signed value of each byte. * * note: this is the same hash method that glib 2.34.0 uses. diff --git a/source/blender/blenlib/intern/math_rotation.c b/source/blender/blenlib/intern/math_rotation.c index de272b12ebd..b971b81fba6 100644 --- a/source/blender/blenlib/intern/math_rotation.c +++ b/source/blender/blenlib/intern/math_rotation.c @@ -872,8 +872,8 @@ void eulO_to_axis_angle(float axis[3], float *angle, const float eul[3], const s * This takes the angle with sin/cos applied so we can avoid calculating it in some cases. * * \param axis rotation axis (must be normalized). - * \param co cos(angle) - * \param si sin(angle) + * \param angle_sin sin(angle) + * \param angle_cos cos(angle) */ void axis_angle_normalized_to_mat3_ex(float mat[3][3], const float axis[3], const float angle_sin, const float angle_cos) diff --git a/source/blender/blenlib/intern/path_util.c b/source/blender/blenlib/intern/path_util.c index 4226a04ca5b..de1ca7ef742 100644 --- a/source/blender/blenlib/intern/path_util.c +++ b/source/blender/blenlib/intern/path_util.c @@ -475,8 +475,6 @@ bool BLI_path_is_unc(const char *name) * of a UNC path which can start with '\\' (short version) * or '\\?\' (long version) * If the path is not a UNC path, return 0 - * - * \param name the path name */ static int BLI_path_unc_prefix_len(const char *path) { diff --git a/source/blender/blenlib/intern/polyfill2d.c b/source/blender/blenlib/intern/polyfill2d.c index 6dff597c530..34aad5c07e9 100644 --- a/source/blender/blenlib/intern/polyfill2d.c +++ b/source/blender/blenlib/intern/polyfill2d.c @@ -369,7 +369,8 @@ static unsigned int pf_index_next(const PolyFill *pf, unsigned index) /** * Triangulates the given (convex or concave) simple polygon to a list of triangle vertices. - * \param vertices pairs describing vertices of the polygon, in either clockwise or counterclockwise order. + * + * \param coords pairs describing vertices of the polygon, in either clockwise or counterclockwise order. * \return triples of triangle indices in clockwise order. * Note the returned array is reused for later calls to the same method. */ diff --git a/source/blender/blenlib/intern/timecode.c b/source/blender/blenlib/intern/timecode.c index 7b2ac9e112b..244c2733ec2 100644 --- a/source/blender/blenlib/intern/timecode.c +++ b/source/blender/blenlib/intern/timecode.c @@ -24,7 +24,7 @@ * ***** END GPL LICENSE BLOCK ***** */ -/** \file blender/blendlib/intern/timecode.c +/** \file blender/blenlib/intern/timecode.c * \ingroup blendlib * * Time-Code string formatting -- cgit v1.2.3