diff options
author | Campbell Barton <ideasman42@gmail.com> | 2014-05-14 09:00:47 +0400 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2014-05-14 09:00:47 +0400 |
commit | 48881ad1e05fffea39091b5d38917c880e8abd4c (patch) | |
tree | 12c8544fd7d6e7385f6866c430fba85b153f372c /source | |
parent | d8c39b878945ce48d731fe86b6843725ba7bc3f0 (diff) |
Code cleanup: doxy comments
Diffstat (limited to 'source')
19 files changed, 23 insertions, 25 deletions
diff --git a/source/blender/blenkernel/intern/tracking_util.c b/source/blender/blenkernel/intern/tracking_util.c index 4ebe8494101..0a8293630c7 100644 --- a/source/blender/blenkernel/intern/tracking_util.c +++ b/source/blender/blenkernel/intern/tracking_util.c @@ -25,7 +25,7 @@ * ***** END GPL LICENSE BLOCK ***** */ -/** \file blender/blenkernel/tracking_util.c +/** \file blender/blenkernel/intern/tracking_util.c * \ingroup bke * * This file contains implementation of function which are used 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: <literal>hash = hash * 33 + c</literal>. 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 diff --git a/source/blender/bmesh/tools/bmesh_bisect_plane.c b/source/blender/bmesh/tools/bmesh_bisect_plane.c index f4318933deb..fcf768bc116 100644 --- a/source/blender/bmesh/tools/bmesh_bisect_plane.c +++ b/source/blender/bmesh/tools/bmesh_bisect_plane.c @@ -284,8 +284,8 @@ finally: /* Main logic */ /** + * \param use_snap_center Snap verts onto the plane. * \param use_tag Only bisect tagged edges and faces. - * \param use_snap Snap verts onto the plane. * \param oflag_center Operator flag, enabled for geometry on the axis (existing and created) */ void BM_mesh_bisect_plane(BMesh *bm, float plane[4], diff --git a/source/blender/bmesh/tools/bmesh_wireframe.c b/source/blender/bmesh/tools/bmesh_wireframe.c index b7d7a595dc9..0860dab0d66 100644 --- a/source/blender/bmesh/tools/bmesh_wireframe.c +++ b/source/blender/bmesh/tools/bmesh_wireframe.c @@ -20,7 +20,7 @@ * ***** END GPL LICENSE BLOCK ***** */ -/** \file blender/bmesh/operators/bmesh_wireframe.c +/** \file blender/bmesh/tools/bmesh_wireframe.c * \ingroup bmesh * * Creates a solid wireframe from connected faces. diff --git a/source/blender/editors/mask/mask_draw.c b/source/blender/editors/mask/mask_draw.c index 92d55cc1abb..5c9df32c6b3 100644 --- a/source/blender/editors/mask/mask_draw.c +++ b/source/blender/editors/mask/mask_draw.c @@ -742,7 +742,7 @@ void ED_mask_draw_region(Mask *mask, ARegion *ar, /* w = BLI_rctf_size_x(&v2d->tot); */ - /* h = BLI_rctf_size_y(&v2d->tot);/*/ + /* h = BLI_rctf_size_y(&v2d->tot); */ zoomx = (float)(BLI_rcti_size_x(&ar->winrct) + 1) / BLI_rctf_size_x(&ar->v2d.cur); diff --git a/source/blender/editors/metaball/mball_edit.c b/source/blender/editors/metaball/mball_edit.c index 1441a1ef4c0..36c7bb404da 100644 --- a/source/blender/editors/metaball/mball_edit.c +++ b/source/blender/editors/metaball/mball_edit.c @@ -191,7 +191,7 @@ enum { static EnumPropertyItem prop_similar_types[] = { {SIMMBALL_TYPE, "TYPE", 0, "Type", ""}, {SIMMBALL_RADIUS, "RADIUS", 0, "Radius", ""}, - {SIMMBALL_STIFFNESS, "STIFFNESS", 0, "Stiffness", ""}, + {SIMMBALL_STIFFNESS, "STIFFNESS", 0, "Stiffness", ""}, {SIMMBALL_ROTATION, "ROTATION", 0, "Rotation", ""}, {0, NULL, 0, NULL, NULL} }; diff --git a/source/blender/editors/space_view3d/view3d_project.c b/source/blender/editors/space_view3d/view3d_project.c index 6ee1750b85d..00ce51a2c0d 100644 --- a/source/blender/editors/space_view3d/view3d_project.c +++ b/source/blender/editors/space_view3d/view3d_project.c @@ -388,7 +388,7 @@ bool ED_view3d_win_to_ray_ex(const ARegion *ar, View3D *v3d, const float mval[2] * \param ar The region (used for the window width and height). * \param v3d The 3d viewport (used for near clipping value). * \param mval The area relative 2d location (such as event->mval, converted into float[2]). - * \param r_ray_co The world-space point where the ray intersects the window plane. + * \param r_ray_start The world-space point where the ray intersects the window plane. * \param r_ray_normal The normalized world-space direction of towards mval. * \param do_clip Optionally clip the start of the ray by the view clipping planes. * \return success, false if the ray is totally clipped. diff --git a/source/blender/editors/space_view3d/view3d_view.c b/source/blender/editors/space_view3d/view3d_view.c index ebdcc757acc..ef99e8d873c 100644 --- a/source/blender/editors/space_view3d/view3d_view.c +++ b/source/blender/editors/space_view3d/view3d_view.c @@ -782,7 +782,7 @@ void ED_view3d_polygon_offset(const RegionView3D *rv3d, const float dist) } /** - * \param rect, optional for picking (can be NULL). + * \param rect optional for picking (can be NULL). */ void view3d_winmatrix_set(ARegion *ar, View3D *v3d, rctf *rect) { diff --git a/source/blender/editors/util/ed_transverts.c b/source/blender/editors/util/ed_transverts.c index 1fa1e5bdc49..3bd927e5b25 100644 --- a/source/blender/editors/util/ed_transverts.c +++ b/source/blender/editors/util/ed_transverts.c @@ -21,7 +21,7 @@ * ***** END GPL LICENSE BLOCK ***** */ -/** \file blender/editors/space_view3d/ed_transverts.c +/** \file blender/editors/util/ed_transverts.c * \ingroup edutil */ diff --git a/source/blender/imbuf/intern/openexr/openexr_api.cpp b/source/blender/imbuf/intern/openexr/openexr_api.cpp index 401070cd799..8d8bb938e98 100644 --- a/source/blender/imbuf/intern/openexr/openexr_api.cpp +++ b/source/blender/imbuf/intern/openexr/openexr_api.cpp @@ -270,6 +270,10 @@ typedef struct _RGBAZ RGBAZ; extern "C" { +/** + * Test presence of OpenEXR file. + * \param mem pointer to loaded OpenEXR bitstream + */ int imb_is_a_openexr(unsigned char *mem) { return Imf::isImfMagic((const char *)mem); diff --git a/source/blender/imbuf/intern/openexr/openexr_api.h b/source/blender/imbuf/intern/openexr/openexr_api.h index 3135795fb3f..bc21d8cea7b 100644 --- a/source/blender/imbuf/intern/openexr/openexr_api.h +++ b/source/blender/imbuf/intern/openexr/openexr_api.h @@ -36,13 +36,8 @@ #ifdef __cplusplus extern "C" { #endif - + #include <stdio.h> - -/** - * Test presence of OpenEXR file. - * \param mem pointer to loaded OpenEXR bitstream - */ void imb_initopenexr (void); diff --git a/source/blender/render/intern/source/texture_ocean.c b/source/blender/render/intern/source/texture_ocean.c index bfd155eba62..55f4bf3794d 100644 --- a/source/blender/render/intern/source/texture_ocean.c +++ b/source/blender/render/intern/source/texture_ocean.c @@ -23,7 +23,7 @@ * ***** END GPL LICENSE BLOCK ***** */ -/** \file blender/blenkernel/intern/texture_ocean.c +/** \file blender/render/intern/source/texture_ocean.c * \ingroup bke */ diff --git a/source/blender/windowmanager/intern/wm_event_system.c b/source/blender/windowmanager/intern/wm_event_system.c index 55f18661712..730934e1f46 100644 --- a/source/blender/windowmanager/intern/wm_event_system.c +++ b/source/blender/windowmanager/intern/wm_event_system.c @@ -759,7 +759,7 @@ static int wm_operator_exec_notest(bContext *C, wmOperator *op) /** * for running operators with frozen context (modal handlers, menus) * - * \param store, Store settings for re-use. + * \param store Store settings for re-use. * * warning: do not use this within an operator to call its self! [#29537] */ int WM_operator_call_ex(bContext *C, wmOperator *op, diff --git a/source/gameengine/Rasterizer/RAS_ILightObject.h b/source/gameengine/Rasterizer/RAS_ILightObject.h index 28c5d9aedd7..f087f3bbb70 100644 --- a/source/gameengine/Rasterizer/RAS_ILightObject.h +++ b/source/gameengine/Rasterizer/RAS_ILightObject.h @@ -25,7 +25,7 @@ * ***** END GPL LICENSE BLOCK ***** */ -/** \file RAS_LightObject.h +/** \file RAS_ILightObject.h * \ingroup bgerast */ diff --git a/source/gameengine/VideoTexture/Exception.h b/source/gameengine/VideoTexture/Exception.h index 4410ec1aa8b..c3c27abe019 100644 --- a/source/gameengine/VideoTexture/Exception.h +++ b/source/gameengine/VideoTexture/Exception.h @@ -24,7 +24,7 @@ * ***** END GPL LICENSE BLOCK ***** */ -/** \file Exception.h +/** \file gameengine/VideoTexture/Exception.h * \ingroup bgevideotex */ |