[Bf-blender-cvs] [4b96f478319] master: Docs: correct invalid doxygen params & references
Campbell Barton
noreply at git.blender.org
Sat Jun 27 08:00:28 CEST 2020
Commit: 4b96f4783197c6bbf34230385b711d685df2b545
Author: Campbell Barton
Date: Sat Jun 27 14:34:16 2020 +1000
Branches: master
https://developer.blender.org/rB4b96f4783197c6bbf34230385b711d685df2b545
Docs: correct invalid doxygen params & references
===================================================================
M source/blender/blenkernel/BKE_undo_system.h
M source/blender/blenkernel/intern/blendfile.c
M source/blender/blenkernel/intern/collection.c
M source/blender/blenkernel/intern/curve.c
M source/blender/blenkernel/intern/curveprofile.c
M source/blender/blenkernel/intern/fcurve.c
M source/blender/blenkernel/intern/gpencil.c
M source/blender/blenkernel/intern/lib_id.c
M source/blender/blenkernel/intern/mesh_evaluate.c
M source/blender/blenkernel/intern/object.c
M source/blender/blenkernel/intern/text.c
M source/blender/blenlib/intern/delaunay_2d.c
M source/blender/blenlib/intern/edgehash.c
M source/blender/blenlib/intern/math_rotation.c
M source/blender/blenlib/intern/storage.c
M source/blender/blenloader/BLO_writefile.h
M source/blender/blenloader/intern/readfile.c
M source/blender/compositor/intern/COM_NodeOperation.h
M source/blender/compositor/nodes/COM_FlipNode.cpp
M source/blender/depsgraph/intern/node/deg_node_component.h
M source/blender/draw/intern/draw_select_buffer.c
M source/blender/editors/animation/anim_filter.c
M source/blender/editors/gpencil/gpencil_utils.c
M source/blender/editors/include/ED_anim_api.h
M source/blender/editors/interface/interface.c
M source/blender/editors/interface/interface_draw.c
M source/blender/editors/screen/area.c
M source/blender/editors/sculpt_paint/sculpt.c
M source/blender/editors/space_text/text_ops.c
M source/blender/editors/transform/transform_snap_object.c
M source/blender/io/alembic/exporter/abc_exporter.cc
M source/blender/makesdna/DNA_action_types.h
M source/blender/makesdna/DNA_mesh_types.h
M source/blender/makesdna/intern/dna_genfile.c
M source/blender/makesdna/intern/makesdna.c
M source/blender/makesrna/intern/rna_access.c
M source/blender/modifiers/intern/MOD_solidify_extrude.c
M source/blender/windowmanager/gizmo/intern/wm_gizmo.c
M source/blender/windowmanager/intern/wm_gesture_ops.c
===================================================================
diff --git a/source/blender/blenkernel/BKE_undo_system.h b/source/blender/blenkernel/BKE_undo_system.h
index f462a7fab71..b32c3e315ff 100644
--- a/source/blender/blenkernel/BKE_undo_system.h
+++ b/source/blender/blenkernel/BKE_undo_system.h
@@ -120,7 +120,9 @@ typedef struct UndoType {
/**
* \note When freeing all steps,
- * free from the last since #MemFileUndoType will merge with the next undo type in the list. */
+ * free from the last since #BKE_UNDOSYS_TYPE_MEMFILE
+ * will merge with the next undo type in the list.
+ */
void (*step_free)(UndoStep *us);
void (*step_foreach_ID_ref)(UndoStep *us,
diff --git a/source/blender/blenkernel/intern/blendfile.c b/source/blender/blenkernel/intern/blendfile.c
index c6af21c6b4e..ee60bf79611 100644
--- a/source/blender/blenkernel/intern/blendfile.c
+++ b/source/blender/blenkernel/intern/blendfile.c
@@ -836,7 +836,7 @@ static void blendfile_write_partial_cb(void *UNUSED(handle), Main *UNUSED(bmain)
}
/**
- * \param remap_mode: Choose the kind of path remapping or none #eBLO_FilePathRemap.
+ * \param remap_mode: Choose the kind of path remapping or none #eBLO_WritePathRemap.
* \return Success.
*/
bool BKE_blendfile_write_partial(Main *bmain_src,
diff --git a/source/blender/blenkernel/intern/collection.c b/source/blender/blenkernel/intern/collection.c
index c38d38bb2e7..07eff64e51c 100644
--- a/source/blender/blenkernel/intern/collection.c
+++ b/source/blender/blenkernel/intern/collection.c
@@ -422,11 +422,6 @@ static Collection *collection_duplicate_recursive(Main *bmain,
* #LIB_ID_DUPLICATE_IS_SUBPROCESS duplicate option is passed on, in which case caller is
* responsible to reconstruct collection dependencies information's
* (i.e. call #BKE_main_collection_sync).
- *
- * \param do_objects: If true, it will also make copies of objects.
- * \param do_obdata: If true, it will also make duplicates of objects,
- * using behavior defined in user settings (#U.dupflag).
- * This one does nothing if \a do_objects is not set.
*/
Collection *BKE_collection_duplicate(Main *bmain,
Collection *parent,
@@ -925,7 +920,7 @@ bool BKE_collection_object_remove(Main *bmain,
/**
* Remove object from all collections of scene
- * \param scene_collection_skip: Don't remove base from this collection.
+ * \param collection_skip: Don't remove base from this collection.
*/
static bool scene_collections_object_remove(
Main *bmain, Scene *scene, Object *ob, const bool free_us, Collection *collection_skip)
diff --git a/source/blender/blenkernel/intern/curve.c b/source/blender/blenkernel/intern/curve.c
index 0b65f53708f..6b28297622c 100644
--- a/source/blender/blenkernel/intern/curve.c
+++ b/source/blender/blenkernel/intern/curve.c
@@ -4081,9 +4081,9 @@ void BKE_nurb_handle_calc(
/**
* Variant of #BKE_nurb_handle_calc() that allows calculating based on a different select flag.
*
- * \param sel_flag: The flag (bezt.f1/2/3) value to use to determine selection. Usually `SELECT`,
- * but may want to use a different one at times (if caller does not operate on
- * selection).
+ * \param handle_sel_flag: The flag (bezt.f1/2/3) value to use to determine selection.
+ * Usually #SELECT, but may want to use a different one at times
+ * (if caller does not operate on selection).
*/
void BKE_nurb_handle_calc_ex(BezTriple *bezt,
BezTriple *prev,
diff --git a/source/blender/blenkernel/intern/curveprofile.c b/source/blender/blenkernel/intern/curveprofile.c
index 7b7cadfcb1b..6919d4fa10f 100644
--- a/source/blender/blenkernel/intern/curveprofile.c
+++ b/source/blender/blenkernel/intern/curveprofile.c
@@ -83,10 +83,10 @@ CurveProfile *BKE_curveprofile_copy(const CurveProfile *profile)
}
/**
- * Move a point's handle, accounting for the alignment of handles with the HD_ALIGN type.
+ * Move a point's handle, accounting for the alignment of handles with the #HD_ALIGN type.
*
- * \param handle_1 Whether to move the 1st or 2nd control point.
- * \param new_location The *relative* change in the handle's position.
+ * \param handle_1: Whether to move the 1st or 2nd control point.
+ * \param delta: The *relative* change in the handle's position.
* \note Requires #BKE_curveprofile_update call after.
* \return Whether the handle moved from its start position.
*/
@@ -133,8 +133,8 @@ bool BKE_curveprofile_move_handle(struct CurveProfilePoint *point,
/**
* Moves a control point, accounting for clipping and snapping, and moving free handles.
*
- * \param snap Whether to snap the point to the grid
- * \param new_location The *relative* change of the point's location.
+ * \param snap: Whether to snap the point to the grid
+ * \param delta: The *relative* change of the point's location.
* \return Whether the point moved from its start position.
* \note Requires #BKE_curveprofile_update call after.
*/
@@ -313,7 +313,7 @@ CurveProfilePoint *BKE_curveprofile_insert(CurveProfile *profile, float x, float
/**
* Sets the handle type of the selected control points.
- * \param type_* Handle type for the first handle. HD_VECT, HD_AUTO, HD_FREE, or HD_ALIGN.
+ * \param type_1, type_2: Handle type for the first handle. HD_VECT, HD_AUTO, HD_FREE, or HD_ALIGN.
* \note Requires #BKE_curveprofile_update call after.
*/
void BKE_curveprofile_selected_handle_set(CurveProfile *profile, int type_1, int type_2)
diff --git a/source/blender/blenkernel/intern/fcurve.c b/source/blender/blenkernel/intern/fcurve.c
index d4754615c7f..bc14f525c2c 100644
--- a/source/blender/blenkernel/intern/fcurve.c
+++ b/source/blender/blenkernel/intern/fcurve.c
@@ -1063,9 +1063,9 @@ static BezTriple *cycle_offset_triple(
/**
* Variant of #calchandles_fcurve() that allows calculating based on a different select flag.
*
- * \param sel_flag: The flag (bezt.f1/2/3) value to use to determine selection. Usually `SELECT`,
- * but may want to use a different one at times (if caller does not operate on
- * selection).
+ * \param handle_sel_flag: The flag (bezt.f1/2/3) value to use to determine selection.
+ * Usually `SELECT`, but may want to use a different one at times
+ * (if caller does not operate on selection).
*/
void calchandles_fcurve_ex(FCurve *fcu, eBezTriple_Flag handle_sel_flag)
{
diff --git a/source/blender/blenkernel/intern/gpencil.c b/source/blender/blenkernel/intern/gpencil.c
index aa5803a5d5f..dece833c00f 100644
--- a/source/blender/blenkernel/intern/gpencil.c
+++ b/source/blender/blenkernel/intern/gpencil.c
@@ -290,9 +290,9 @@ void BKE_gpencil_eval_delete(bGPdata *gpd_eval)
}
/**
- * Tag datablock for depsgraph update.
+ * Tag data-block for depsgraph update.
* Wrapper to avoid include Depsgraph tag functions in other modules.
- * \param gpd Grease pencil datablock
+ * \param gpd: Grease pencil data-block.
*/
void BKE_gpencil_tag(bGPdata *gpd)
{
@@ -427,7 +427,7 @@ bGPDlayer *BKE_gpencil_layer_addnew(bGPdata *gpd, const char *name, bool setacti
gpl_active = BKE_gpencil_layer_active_get(gpd);
- /* add to datablock */
+ /* Add to data-block. */
if (gpl_active == NULL) {
BLI_addtail(&gpd->layers, gpl);
}
@@ -479,7 +479,9 @@ bGPDlayer *BKE_gpencil_layer_addnew(bGPdata *gpd, const char *name, bool setacti
return gpl;
}
-/* add a new gp-datablock */
+/**
+ * Add a new grease pencil data-block.
+ */
bGPdata *BKE_gpencil_data_addnew(Main *bmain, const char name[])
{
bGPdata *gpd;
@@ -506,7 +508,7 @@ bGPdata *BKE_gpencil_data_addnew(Main *bmain, const char name[])
ARRAY_SET_ITEMS(gpd->grid.scale, 1.0f, 1.0f); /* Scale */
gpd->grid.lines = GP_DEFAULT_GRID_LINES; /* Number of lines */
- /* onion-skinning settings (datablock level) */
+ /* Onion-skinning settings (data-block level) */
gpd->onion_flag |= (GP_ONION_GHOST_PREVCOL | GP_ONION_GHOST_NEXTCOL);
gpd->onion_flag |= GP_ONION_FADE;
gpd->onion_mode = GP_ONION_MODE_RELATIVE;
@@ -526,8 +528,8 @@ bGPdata *BKE_gpencil_data_addnew(Main *bmain, const char name[])
/**
* Populate stroke with point data from data buffers
*
- * \param array: Flat array of point data values. Each entry has GP_PRIM_DATABUF_SIZE values
- * \param mat: 4x4 transform matrix to transform points into the right coordinate space
+ * \param array: Flat array of point data values. Each entry has #GP_PRIM_DATABUF_SIZE values.
+ * \param mat: 4x4 transform matrix to transform points into the right coordinate space.
*/
void BKE_gpencil_stroke_add_points(bGPDstroke *gps,
const float *array,
@@ -738,7 +740,9 @@ bGPDlayer *BKE_gpencil_layer_duplicate(const bGPDlayer *gpl_src)
return gpl_dst;
}
-/* Standard API to make a copy of GP datablock, separate from copying its data */
+/**
+ * Standard API to make a copy of GP data-block, separate from copying its data.
+ */
bGPdata *BKE_gpencil_copy(Main *bmain, const bGPdata *gpd)
{
bGPdata *gpd_copy;
@@ -746,8 +750,11 @@ bGPdata *BKE_gpencil_copy(Main *bmain, const bGPdata *gpd)
return gpd_copy;
}
-/* make a copy of a given gpencil datablock */
-/* XXX: Should this be deprecated? */
+/**
+ * Make a copy of a given gpencil data-block.
+ *
+ * XXX: Should this be deprecated?
+ */
bGPdata *BKE_gpencil_data_duplicate(Main *bmain, const bGPdata *gpd_src, bool internal_copy)
{
bGPdata *gpd_dst;
@@ -1329,7 +1336,7 @@ int BKE_gpencil_object_material_ensure(Main *bmain, Object *ob, Material *materi
/**
* Creates a new gpencil material and assigns it to object.
*
- * \param *r_index: value is set to zero based index of the new material if r_index is not NULL
+ * \param *r_index: value is set to zero based index of the new material if \a r_index is not NULL.
*/
Material *BKE_gpencil_object_material_new(Main *bmain, Object *ob, const char *name, int *r_index)
{
@@ -1501,9 +1508,9 @@ void BKE_gpencil_dvert_ensure(bGPDstroke *gps)
* Get range of selected frames in layer.
* Always the active frame is considered as selected, so if no more selected the range
* will be equal to the current active frame.
- * \param gpl: Layer
- * \param r_initframe: Number of first selected frame
- * \par
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list