Commit: 16fc62e15f0a749d6d64e784ea048e07d6ea3397 Author: Campbell Barton Date: Wed Dec 12 12:17:42 2018 +1100 Branches: blender2.8 https://developer.blender.org/rB16fc62e15f0a749d6d64e784ea048e07d6ea3397
Docs: correct doxy comments =================================================================== M source/blender/blenkernel/intern/particle.c M source/blender/blenlib/intern/math_solvers.c M source/blender/blenlib/intern/path_util.c M source/blender/editors/space_view3d/view3d_utils.c M source/blender/editors/transform/transform_snap_object.c M source/blender/gpu/intern/gpu_immediate_util.c M source/blender/gpu/intern/gpu_material.c M source/blender/windowmanager/gizmo/intern/wm_gizmo.c =================================================================== diff --git a/source/blender/blenkernel/intern/particle.c b/source/blender/blenkernel/intern/particle.c index 5bfadd9b277..d51b39514f4 100644 --- a/source/blender/blenkernel/intern/particle.c +++ b/source/blender/blenkernel/intern/particle.c @@ -1322,13 +1322,13 @@ static void psys_origspace_to_w(OrigSpaceFace *osface, int quad, const float w[4 * Find the final derived mesh tessface for a particle, from its original tessface index. * This is slow and can be optimized but only for many lookups. * - * \param dm_final final DM, it may not have the same topology as original mesh. - * \param dm_deformed deformed-only DM, it has the exact same topology as original mesh. - * \param findex_orig the input tessface index. - * \param fw face weights (position of the particle inside the \a findex_orig tessface). - * \param poly_nodes may be NULL, otherwise an array of linked list, one for each final DM polygon, containing all - * its tessfaces indices. - * \return the DM tessface index. + * \param mesh_final: Final mesh, it may not have the same topology as original mesh. + * \param mesh_original: Original mesh, use for accessing #MPoly to #MFace mapping. + * \param findex_orig: The input tessface index. + * \param fw: Face weights (position of the particle inside the \a findex_orig tessface). + * \param poly_nodes: May be NULL, otherwise an array of linked list, + * one for each final \a mesh_final polygon, containing all its tessfaces indices. + * \return The \a mesh_final tessface index. */ int psys_particle_dm_face_lookup( Mesh *mesh_final, Mesh *mesh_original, diff --git a/source/blender/blenlib/intern/math_solvers.c b/source/blender/blenlib/intern/math_solvers.c index 7b9727ead8e..23fd10e0242 100644 --- a/source/blender/blenlib/intern/math_solvers.c +++ b/source/blender/blenlib/intern/math_solvers.c @@ -189,7 +189,6 @@ bool BLI_tridiagonal_solve_cyclic(const float *a, const float *b, const float *c * \param userdata Data for the callbacks. * \param epsilon Desired precision. * \param max_iterations Limit on the iterations. - * \param max_corrections Limit on the number of times the correction callback can fire before giving up. * \param trace Enables logging to console. * \param x_init Initial solution vector. * \param result Final result. diff --git a/source/blender/blenlib/intern/path_util.c b/source/blender/blenlib/intern/path_util.c index a7118a583b5..885fb4d9202 100644 --- a/source/blender/blenlib/intern/path_util.c +++ b/source/blender/blenlib/intern/path_util.c @@ -80,10 +80,10 @@ static bool BLI_path_is_abs(const char *name); * Looks for a sequence of decimal digits in string, preceding any filename extension, * returning the integer value if found, or 0 if not. * - * \param string String to scan. - * \param head Optional area to return copy of part of string prior to digits, or before dot if no digits. - * \param tail Optional area to return copy of part of string following digits, or from dot if no digits. - * \param numlen Optional to return number of digits found. + * \param string: String to scan. + * \param head: Optional area to return copy of part of string prior to digits, or before dot if no digits. + * \param tail: Optional area to return copy of part of string following digits, or from dot if no digits. + * \param r_num_len: Optional to return number of digits found. */ int BLI_stringdec(const char *string, char *head, char *tail, ushort *r_num_len) { diff --git a/source/blender/editors/space_view3d/view3d_utils.c b/source/blender/editors/space_view3d/view3d_utils.c index a5be2a8cc83..bcfaf9e9afa 100644 --- a/source/blender/editors/space_view3d/view3d_utils.c +++ b/source/blender/editors/space_view3d/view3d_utils.c @@ -1333,7 +1333,6 @@ void ED_view3d_to_m4(float mat[4][4], const float ofs[3], const float quat[4], c /** * Set the RegionView3D members from an objects transformation and optionally lens. - * \param depsgraph The depsgraph to get the evaluated object for the lens calculation. * \param ob The object to set the view to. * \param ofs The view offset to be set, normally from RegionView3D.ofs. * \param quat The view rotation to be set, quaternion normally from RegionView3D.viewquat. diff --git a/source/blender/editors/transform/transform_snap_object.c b/source/blender/editors/transform/transform_snap_object.c index 64facb19f09..0081fc6c8b0 100644 --- a/source/blender/editors/transform/transform_snap_object.c +++ b/source/blender/editors/transform/transform_snap_object.c @@ -211,7 +211,6 @@ typedef void(*IterSnapObjsCallback)(SnapObjectContext *sctx, bool is_obedit, Obj * * \param sctx: Snap context to store data. * \param snap_select : from enum eSnapSelect. - * \param obedit : Object Edited to use its coordinates of BMesh(if any) to do the snapping. */ static void iter_snap_objects( SnapObjectContext *sctx, @@ -2281,13 +2280,11 @@ static void sanp_obj_cb(SnapObjectContext *sctx, bool is_obedit, Object *ob, flo * * \param sctx: Snap context to store data. * \param snapdata: struct generated in `get_snapdata`. - * \param snap_select : from enum eSnapSelect. - * \param use_object_edit_cage : Uses the coordinates of BMesh(if any) to do the snapping. + * \param params: Parameters for control snap behavior. * * Read/Write Args * --------------- * - * \param ray_depth: maximum depth allowed for r_co, elements deeper than this value will be ignored. * \param dist_px: Maximum threshold distance (in pixels). * * Output Args @@ -2669,7 +2666,7 @@ bool ED_transform_snap_object_project_view3d_ex( * Given a 2D region value, snap to vert/edge/face. * * \param sctx: Snap context. - * \param mval_fl: Screenspace coordinate. + * \param mval: Screenspace coordinate. * \param dist_px: Maximum distance to snap (in pixels). * \param r_co: hit location. * \param r_no: hit normal (optional). diff --git a/source/blender/gpu/intern/gpu_immediate_util.c b/source/blender/gpu/intern/gpu_immediate_util.c index 5cba0c42ee3..a9e98314014 100644 --- a/source/blender/gpu/intern/gpu_immediate_util.c +++ b/source/blender/gpu/intern/gpu_immediate_util.c @@ -153,7 +153,7 @@ void immRecti_complete(int x1, int y1, int x2, int y2, const float color[4]) * * \note BGR format (i.e. 0xBBGGRR)... * - * \param x color. + * \param x: color. */ void imm_cpack(uint x) { @@ -177,11 +177,11 @@ static void imm_draw_circle( * Draw a circle outline with the given \a radius. * The circle is centered at \a x, \a y and drawn in the XY plane. * - * \param shdr_pos The vertex attribute number for position. - * \param x Horizontal center. - * \param y Vertical center. - * \param radius The circle's radius. - * \param nsegments The number of segments to use in drawing (more = smoother). + * \param shdr_pos: The vertex attribute number for position. + * \param x: Horizontal center. + * \param y: Vertical center. + * \param rad: The circle's radius. + * \param nsegments: The number of segments to use in drawing (more = smoother). */ void imm_draw_circle_wire_2d(uint shdr_pos, float x, float y, float rad, int nsegments) { @@ -192,11 +192,11 @@ void imm_draw_circle_wire_2d(uint shdr_pos, float x, float y, float rad, int nse * Draw a filled circle with the given \a radius. * The circle is centered at \a x, \a y and drawn in the XY plane. * - * \param shdr_pos The vertex attribute number for position. - * \param x Horizontal center. - * \param y Vertical center. - * \param radius The circle's radius. - * \param nsegments The number of segments to use in drawing (more = smoother). + * \param shdr_pos: The vertex attribute number for position. + * \param x: Horizontal center. + * \param y: Vertical center. + * \param rad: The circle's radius. + * \param nsegments: The number of segments to use in drawing (more = smoother). */ void imm_draw_circle_fill_2d(uint shdr_pos, float x, float y, float rad, int nsegments) { @@ -269,8 +269,8 @@ static void imm_draw_disk_partial( * \param pos: The vertex attribute number for position. * \param x: Horizontal center. * \param y: Vertical center. - * \param radius_inner: The inner circle's radius. - * \param radius_outer: The outer circle's radius (can be zero). + * \param rad_inner: The inner circle's radius. + * \param rad_outer: The outer circle's radius (can be zero). * \param nsegments: The number of segments to use in drawing (more = smoother). * \param start: Specifies the starting angle, in degrees, of the disk portion. * \param sweep: Specifies the sweep angle, in degrees, of the disk portion. @@ -307,11 +307,11 @@ void imm_draw_circle_fill_3d(uint pos, float x, float y, float rad, int nsegment /** * Draw a lined box. * - * \param pos The vertex attribute number for position. - * \param x1 left. - * \param y1 bottom. - * \param x2 right. - * \param y2 top. + * \param pos: The vertex attribute number for position. + * \param x1: left. + * \param y1: bottom. + * \param x2: right. + * \param y2: top. */ void imm_draw_box_wire_2d(uint pos, float x1, float y1, float x2, float y2) { @@ -392,13 +392,13 @@ void imm_draw_cube_wire_3d(uint pos, const float co[3], const float aspect[3]) * Draw a cylinder. Replacement for gluCylinder. * _warning_ : Slow, better use it only if you no other choices. * - * \param pos The vertex attribute number for position. - * \param nor The vertex attribute number for normal. - * \param base Specifies the radius of the cylinder at z = 0. - * \param top Specifies the radius of the cylinder at z = height. - * \param height Specifies the height of the cylinder. - * \param slices Specifies the number of subdivisions around the z axis. - * \param stacks Specifies the number of subdivisions along the z axis. + * \param pos: The vertex attribute number for position. + * \param nor: The vertex attribute number for normal. + * \param base: Specifies the radius of the cylinder at z = 0. + * \param top: Specifies the radius of the cylinder at z = height. + * \param height: Specifies the height of the cylinder. + * \param slices: Specifies the number of subdivisions around the z axis. + * \param stacks: Specifies the number of subdivisions along the z axis. */ @@ Diff output truncated at 10240 characters. @@ _______________________________________________ Bf-blender-cvs mailing list Bf-blender-cvs@blender.org https://lists.blender.org/mailman/listinfo/bf-blender-cvs