Docs: correct doxy comments
authorCampbell Barton <ideasman42@gmail.com>
Wed, 12 Dec 2018 01:17:42 +0000 (12:17 +1100)
committerCampbell Barton <ideasman42@gmail.com>
Wed, 12 Dec 2018 01:18:52 +0000 (12:18 +1100)
source/blender/blenkernel/intern/particle.c
source/blender/blenlib/intern/math_solvers.c
source/blender/blenlib/intern/path_util.c
source/blender/editors/space_view3d/view3d_utils.c
source/blender/editors/transform/transform_snap_object.c
source/blender/gpu/intern/gpu_immediate_util.c
source/blender/gpu/intern/gpu_material.c
source/blender/windowmanager/gizmo/intern/wm_gizmo.c

index 5bfadd9..d51b395 100644 (file)
@@ -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,
index 7b9727e..23fd10e 100644 (file)
@@ -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.
index a7118a5..885fb4d 100644 (file)
@@ -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)
 {
index a5be2a8..bcfaf9e 100644 (file)
@@ -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.
index 64facb1..0081fc6 100644 (file)
@@ -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).
index 5cba0c4..a9e9831 100644 (file)
@@ -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.
  */
 void imm_draw_cylinder_fill_normal_3d(
         uint pos, uint nor, float base, float top, float height, int slices, int stacks)
index 1002e6f..746ba96 100644 (file)
@@ -242,7 +242,8 @@ GPUUniformBuffer *GPU_material_uniform_buffer_get(GPUMaterial *material)
 
 /**
  * Create dynamic UBO from parameters
- * \param ListBase of BLI_genericNodeN(GPUInput)
+ *
+ * \param inputs: Items are #LinkData, data is #GPUInput (`BLI_genericNodeN(GPUInput)`).
  */
 void GPU_material_uniform_buffer_create(GPUMaterial *material, ListBase *inputs)
 {
index 123857f..3a4b8af 100644 (file)
@@ -121,7 +121,7 @@ wmGizmo *WM_gizmo_new_ptr(
 }
 
 /**
- * \param gt: Must be valid,
+ * \param name: Must be a valid gizmo type name,
  * if you need to check it exists use #WM_gizmo_new_ptr
  * because callers of this function don't NULL check the return value.
  */
@@ -151,8 +151,6 @@ static void gizmo_init(wmGizmo *gz)
 /**
  * Register \a gizmo.
  *
- * \param name: name used to create a unique idname for \a gizmo in \a gzgroup
- *
  * \note Not to be confused with type registration from RNA.
  */
 static void wm_gizmo_register(wmGizmoGroup *gzgroup, wmGizmo *gz)
@@ -357,12 +355,6 @@ void WM_gizmo_set_line_width(wmGizmo *gz, const float line_width)
        gz->line_width = line_width;
 }
 
-/**
- * Set gizmo rgba colors.
- *
- * \param col  Normal state color.
- * \param col_hi  Highlighted state color.
- */
 void WM_gizmo_get_color(const wmGizmo *gz, float color[4])
 {
        copy_v4_v4(color, gz->color);