Code cleanup: doxy comments

This commit is contained in:
Campbell Barton 2014-05-14 15:00:47 +10:00
parent d8c39b8789
commit 48881ad1e0
19 changed files with 23 additions and 25 deletions

@ -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

@ -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.

@ -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)

@ -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)
{

@ -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.
*/

@ -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

@ -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],

@ -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.

@ -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);

@ -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.

@ -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)
{

@ -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
*/

@ -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);

@ -39,11 +39,6 @@ extern "C" {
#include <stdio.h>
/**
* Test presence of OpenEXR file.
* \param mem pointer to loaded OpenEXR bitstream
*/
void imb_initopenexr (void);
int imb_is_a_openexr (unsigned char *mem);

@ -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
*/

@ -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,

@ -25,7 +25,7 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file RAS_LightObject.h
/** \file RAS_ILightObject.h
* \ingroup bgerast
*/

@ -24,7 +24,7 @@
* ***** END GPL LICENSE BLOCK *****
*/
/** \file Exception.h
/** \file gameengine/VideoTexture/Exception.h
* \ingroup bgevideotex
*/