[Bf-blender-cvs] [48881ad] master: Code cleanup: doxy comments
Campbell Barton
noreply at git.blender.org
Wed May 14 07:01:26 CEST 2014
Commit: 48881ad1e05fffea39091b5d38917c880e8abd4c
Author: Campbell Barton
Date: Wed May 14 15:00:47 2014 +1000
https://developer.blender.org/rB48881ad1e05fffea39091b5d38917c880e8abd4c
Code cleanup: doxy comments
===================================================================
M source/blender/blenkernel/intern/tracking_util.c
M source/blender/blenlib/intern/BLI_ghash.c
M source/blender/blenlib/intern/math_rotation.c
M source/blender/blenlib/intern/path_util.c
M source/blender/blenlib/intern/polyfill2d.c
M source/blender/blenlib/intern/timecode.c
M source/blender/bmesh/tools/bmesh_bisect_plane.c
M source/blender/bmesh/tools/bmesh_wireframe.c
M source/blender/editors/mask/mask_draw.c
M source/blender/editors/metaball/mball_edit.c
M source/blender/editors/space_view3d/view3d_project.c
M source/blender/editors/space_view3d/view3d_view.c
M source/blender/editors/util/ed_transverts.c
M source/blender/imbuf/intern/openexr/openexr_api.cpp
M source/blender/imbuf/intern/openexr/openexr_api.h
M source/blender/render/intern/source/texture_ocean.c
M source/blender/windowmanager/intern/wm_event_system.c
M source/gameengine/Rasterizer/RAS_ILightObject.h
M source/gameengine/VideoTexture/Exception.h
===================================================================
diff --git a/source/blender/blenkernel/intern/tracking_util.c b/source/blender/blenkernel/intern/tracking_util.c
index 4ebe849..0a82936 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 7b48744..e55f20e 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 de272b1..b971b81 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 4226a04..de1ca7e 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 6dff597..34aad5c 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 7b2ac9e..244c273 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 f431893..fcf768b 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 b7d7a59..0860dab 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 92d55cc..5c9df32 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 1441a1e..36c7bb4 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 6ee1750..00ce51a 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 ebdcc75..ef99e8d 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 1fa1e5b..3bd927e 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 401070c..8d8bb93 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 3135795..bc21d8c 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 bfd155e..55f4bf3 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 55f1866..730934e 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 28c5d9a..f087f3b 100644
--- a/source/gameengine/Rasterizer/RAS_ILightObject.h
+++ b/sou
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list