[Bf-blender-cvs] [249f4423ee1] master: Cleanup: doxygen comments

Campbell Barton noreply at git.blender.org
Sun Nov 24 15:57:21 CET 2019


Commit: 249f4423ee1c28e7f8ad6fdfff6c61a1f3e6d53d
Author: Campbell Barton
Date:   Mon Nov 25 01:14:39 2019 +1100
Branches: master
https://developer.blender.org/rB249f4423ee1c28e7f8ad6fdfff6c61a1f3e6d53d

Cleanup: doxygen comments

Also correct some outdated symbol references,
add missing 'name' commands.

===================================================================

M	intern/ghost/intern/GHOST_ContextCGL.mm
M	intern/memutil/MEM_RefCountedC-Api.h
M	source/blender/blenkernel/BKE_DerivedMesh.h
M	source/blender/blenkernel/BKE_customdata.h
M	source/blender/blenkernel/BKE_node.h
M	source/blender/blenkernel/intern/action.c
M	source/blender/blenkernel/intern/anim_sys.c
M	source/blender/blenkernel/intern/armature.c
M	source/blender/blenkernel/intern/colortools.c
M	source/blender/blenkernel/intern/crazyspace.c
M	source/blender/blenkernel/intern/curveprofile.c
M	source/blender/blenkernel/intern/font.c
M	source/blender/blenkernel/intern/gpencil.c
M	source/blender/blenkernel/intern/icons.c
M	source/blender/blenkernel/intern/key.c
M	source/blender/blenkernel/intern/library.c
M	source/blender/blenkernel/intern/library_override.c
M	source/blender/blenkernel/intern/library_remap.c
M	source/blender/blenkernel/intern/mball.c
M	source/blender/blenkernel/intern/mesh_evaluate.c
M	source/blender/blenkernel/intern/object.c
M	source/blender/blenkernel/intern/scene.c
M	source/blender/blenkernel/intern/screen.c
M	source/blender/blenkernel/intern/studiolight.c
M	source/blender/blenkernel/intern/undo_system.c
M	source/blender/blenlib/BLI_array.h
M	source/blender/blenlib/BLI_rand.h
M	source/blender/blenlib/BLI_voxel.h
M	source/blender/blenlib/intern/delaunay_2d.c
M	source/blender/blenlib/intern/hash_md5.c
M	source/blender/blenlib/intern/kdtree_impl.h
M	source/blender/blenlib/intern/math_base_inline.c
M	source/blender/blenlib/intern/math_geom.c
M	source/blender/blenlib/intern/math_matrix.c
M	source/blender/blenlib/intern/math_rotation.c
M	source/blender/blenlib/intern/path_util.c
M	source/blender/bmesh/intern/bmesh_core.c
M	source/blender/bmesh/intern/bmesh_mesh.c
M	source/blender/bmesh/operators/bmo_subdivide_edgering.c
M	source/blender/bmesh/tools/bmesh_bevel.c
M	source/blender/bmesh/tools/bmesh_decimate_collapse.c
M	source/blender/collada/DocumentImporter.cpp
M	source/blender/compositor/intern/COM_ExecutionGroup.cpp
M	source/blender/compositor/intern/COM_NodeGraph.cpp
M	source/blender/compositor/intern/COM_NodeGraph.h
M	source/blender/draw/engines/eevee/shaders/lit_surface_frag.glsl
M	source/blender/editors/armature/armature_add.c
M	source/blender/editors/curve/editcurve.c
M	source/blender/editors/interface/interface_handlers.c
M	source/blender/editors/interface/interface_ops.c
M	source/blender/editors/interface/interface_templates.c
M	source/blender/editors/interface/interface_widgets.c
M	source/blender/editors/interface/resources.c
M	source/blender/editors/mesh/meshtools.c
M	source/blender/editors/object/object_transform.c
M	source/blender/editors/sculpt_paint/paint_image_proj.c
M	source/blender/editors/space_file/fsmenu.h
M	source/blender/editors/space_outliner/outliner_draw.c
M	source/blender/editors/space_outliner/outliner_tools.c
M	source/blender/editors/space_view3d/view3d_select.c
M	source/blender/editors/space_view3d/view3d_snap.c
M	source/blender/editors/space_view3d/view3d_view.c
M	source/blender/editors/transform/transform.h
M	source/blender/editors/transform/transform_convert_mesh.c
M	source/blender/editors/transform/transform_snap_object.c
M	source/blender/editors/util/numinput.c
M	source/blender/gpu/GPU_shader.h
M	source/blender/gpu/shaders/material/gpu_shader_material_tex_image.glsl
M	source/blender/imbuf/IMB_metadata.h
M	source/blender/imbuf/IMB_thumbs.h
M	source/blender/imbuf/intern/rectop.c
M	source/blender/imbuf/intern/thumbs.c
M	source/blender/makesdna/DNA_curveprofile_types.h
M	source/blender/makesdna/DNA_customdata_types.h
M	source/blender/makesdna/DNA_meshdata_types.h
M	source/blender/makesdna/DNA_object_enums.h
M	source/blender/makesdna/DNA_object_force_types.h
M	source/blender/makesdna/DNA_scene_types.h
M	source/blender/makesdna/DNA_space_types.h
M	source/blender/makesdna/DNA_userdef_types.h
M	source/blender/makesdna/intern/makesdna.c
M	source/blender/makesrna/RNA_types.h
M	source/blender/makesrna/intern/rna_access_compare_override.c
M	source/blender/modifiers/intern/MOD_weightvgproximity.c
M	source/blender/python/bmesh/bmesh_py_types_meshdata.c
M	source/blender/python/intern/bpy_rna.c
M	source/blender/windowmanager/WM_api.h
M	source/blender/windowmanager/gizmo/intern/wm_gizmo.c
M	source/blender/windowmanager/intern/wm_operators.c

===================================================================

diff --git a/intern/ghost/intern/GHOST_ContextCGL.mm b/intern/ghost/intern/GHOST_ContextCGL.mm
index 12c340ffe97..1fbce0c1e6b 100644
--- a/intern/ghost/intern/GHOST_ContextCGL.mm
+++ b/intern/ghost/intern/GHOST_ContextCGL.mm
@@ -17,7 +17,7 @@
  * All rights reserved.
  */
 
-/** \file ghost/intern/GHOST_ContextCGL.mm
+/** \file
  *  \ingroup GHOST
  *
  * Definition of GHOST_ContextCGL class.
diff --git a/intern/memutil/MEM_RefCountedC-Api.h b/intern/memutil/MEM_RefCountedC-Api.h
index 25dcf11b7aa..2a132f3c173 100644
--- a/intern/memutil/MEM_RefCountedC-Api.h
+++ b/intern/memutil/MEM_RefCountedC-Api.h
@@ -37,23 +37,23 @@ extern "C" {
 
 /**
  * Returns the reference count of this object.
- * @param shared The object to query.
- * @return The current reference count.
+ * \param shared: The object to query.
+ * \return The current reference count.
  */
 extern int MEM_RefCountedGetRef(MEM_TRefCountedObjectPtr shared);
 
 /**
  * Increases the reference count of this object.
- * @param shared The object to query.
- * @return The new reference count.
+ * \param shared: The object to query.
+ * \return The new reference count.
  */
 extern int MEM_RefCountedIncRef(MEM_TRefCountedObjectPtr shared);
 
 /**
  * Decreases the reference count of this object.
  * If the reference count reaches zero, the object self-destructs.
- * @param shared The object to query.
- * @return The new reference count.
+ * \param shared: The object to query.
+ * \return The new reference count.
  */
 extern int MEM_RefCountedDecRef(MEM_TRefCountedObjectPtr shared);
 
diff --git a/source/blender/blenkernel/BKE_DerivedMesh.h b/source/blender/blenkernel/BKE_DerivedMesh.h
index 2145a673e45..e167cfd6fcb 100644
--- a/source/blender/blenkernel/BKE_DerivedMesh.h
+++ b/source/blender/blenkernel/BKE_DerivedMesh.h
@@ -296,8 +296,9 @@ void DM_from_template(DerivedMesh *dm,
                       int numLoops,
                       int numPolys);
 
-/** utility function to release a DerivedMesh's layers
- * returns 1 if DerivedMesh has to be released by the backend, 0 otherwise
+/**
+ * Utility function to release a DerivedMesh's layers
+ * returns 1 if DerivedMesh has to be released by the backend, 0 otherwise.
  */
 int DM_release(DerivedMesh *dm);
 
diff --git a/source/blender/blenkernel/BKE_customdata.h b/source/blender/blenkernel/BKE_customdata.h
index f354e5e6de3..f5665707a0c 100644
--- a/source/blender/blenkernel/BKE_customdata.h
+++ b/source/blender/blenkernel/BKE_customdata.h
@@ -168,8 +168,8 @@ bool CustomData_bmesh_merge(const struct CustomData *source,
 /** NULL's all members and resets the typemap. */
 void CustomData_reset(struct CustomData *data);
 
-/** frees data associated with a CustomData object (doesn't free the object
- * itself, though)
+/**
+ * Frees data associated with a CustomData object (doesn't free the object itself, though).
  */
 void CustomData_free(struct CustomData *data, int totelem);
 
diff --git a/source/blender/blenkernel/BKE_node.h b/source/blender/blenkernel/BKE_node.h
index a5b9b1e5148..9501d3f8ec9 100644
--- a/source/blender/blenkernel/BKE_node.h
+++ b/source/blender/blenkernel/BKE_node.h
@@ -74,7 +74,9 @@ struct uiLayout;
 /** \name Node Type Definitions
  * \{ */
 
-/** Compact definition of a node socket.
+/**
+ * \brief Compact definition of a node socket.
+ *
  * Can be used to quickly define a list of static sockets for a node,
  * which are added to each new node of that type.
  *
@@ -95,7 +97,9 @@ typedef struct bNodeSocketTemplate {
   char identifier[64];      /* generated from name */
 } bNodeSocketTemplate;
 
-/** Defines a socket type.
+/**
+ * \brief Defines a socket type.
+ *
  * Defines the appearance and behavior of a socket in the UI.
  */
 typedef struct bNodeSocketType {
@@ -155,7 +159,9 @@ typedef int (*NodeGPUExecFunction)(struct GPUMaterial *mat,
                                    struct GPUNodeStack *in,
                                    struct GPUNodeStack *out);
 
-/** Defines a node type.
+/**
+ * \brief Defines a node type.
+ *
  * Initial attributes and constants for a node as well as callback functions
  * implementing the node behavior.
  */
diff --git a/source/blender/blenkernel/intern/action.c b/source/blender/blenkernel/intern/action.c
index de1cbd236fb..ad6c696b655 100644
--- a/source/blender/blenkernel/intern/action.c
+++ b/source/blender/blenkernel/intern/action.c
@@ -502,9 +502,10 @@ bool BKE_pose_channels_is_valid(const bPose *pose)
 #endif
 
 /**
- * Find the active posechannel for an object (we can't just use pose, as layer info is in armature)
+ * Find the active pose-channel for an object
+ * (we can't just use pose, as layer info is in armature)
  *
- * \note: Object, not bPose is used here, as we need layer info from Armature)
+ * \note #Object, not #bPose is used here, as we need layer info from Armature.
  */
 bPoseChannel *BKE_pose_channel_active(Object *ob)
 {
diff --git a/source/blender/blenkernel/intern/anim_sys.c b/source/blender/blenkernel/intern/anim_sys.c
index 2e655452a21..88a8463b994 100644
--- a/source/blender/blenkernel/intern/anim_sys.c
+++ b/source/blender/blenkernel/intern/anim_sys.c
@@ -180,8 +180,10 @@ AnimData *BKE_animdata_add_id(ID *id)
 
 /* Action Setter --------------------------------------- */
 
-/** Called when user tries to change the active action of an AnimData block
- * (via RNA, Outliner, etc.) */
+/**
+ * Called when user tries to change the active action of an AnimData block
+ * (via RNA, Outliner, etc.)
+ */
 bool BKE_animdata_set_action(ReportList *reports, ID *id, bAction *act)
 {
   AnimData *adt = BKE_animdata_from_id(id);
diff --git a/source/blender/blenkernel/intern/armature.c b/source/blender/blenkernel/intern/armature.c
index 4d9a92d3ead..58b0c9b41ea 100644
--- a/source/blender/blenkernel/intern/armature.c
+++ b/source/blender/blenkernel/intern/armature.c
@@ -1239,8 +1239,10 @@ void BKE_pchan_bbone_segments_cache_copy(bPoseChannel *pchan, bPoseChannel *pcha
   }
 }
 
-/** Calculate index and blend factor for the two B-Bone segment nodes
- * affecting the point at 0 <= pos <= 1. */
+/**
+ * Calculate index and blend factor for the two B-Bone segment nodes
+ * affecting the point at 0 <= pos <= 1.
+ */
 void BKE_pchan_bbone_deform_segment_index(const bPoseChannel *pchan,
                                           float pos,
                                           int *r_index,
diff --git a/source/blender/blenkernel/intern/colortools.c b/source/blender/blenkernel/intern/colortools.c
index b129bf14bb8..8166bbea962 100644
--- a/source/blender/blenkernel/intern/colortools.c
+++ b/source/blender/blenkernel/intern/colortools.c
@@ -1051,7 +1051,8 @@ static void curvemapping_evaluateRGBF_filmlike(const CurveMapping *cumap,
   vecout[channel_offset[2]] = v2;
 }
 
-/** same as #BKE_curvemapping_evaluate_premulRGBF
+/**
+ * Same as #BKE_curvemapping_evaluate_premulRGBF
  * but black/bwmul are passed as args for the compositor
  * where they can change per pixel.
  *
diff --git a/source/blender/blenkernel/intern/crazyspace.c b/source/blender/blenkernel/intern/crazyspace.c
index f2ed84b4125..9618ef8c78e 100644
--- a/source/blender/blenkernel/intern/crazyspace.c
+++ b/source/blender/blenkernel/intern/crazyspace.c
@@ -251,8 +251,10 @@ void BKE_crazyspace_set_quats_mesh(Mesh *me,
   }
 }
 
-/** returns an array of deform matrices for crazyspace correction, and the
- * number of modifiers left */
+/**
+ * Returns an array of deform matrices for crazyspace correction,
+ * and the number of modifiers left.
+ */
 int BKE_crazyspace_get_first_deform_matrices_editbmesh(struct Depsgraph *depsgraph,
                                                        Scene *scene,
                                                        Object *ob,
diff --git a/source/blender/blenkernel/intern/curveprofile.c b/source/blender/blenkernel/intern/curveprofile.c
index f07d29c0807..2b253d439e0 100644
--- a/source/blender/blenkernel/intern/curveprofile.c
+++ b/source/blender/blenkernel/intern/curveprofile.c
@@ -75,8 +75,10 @@ CurveProfile *BKE_curveprofile_copy(const CurveProfile *profile)
   return NULL;
 }
 
-/** Removes a specific point from the path of control points.
- * \note: Requires curveprofile_update call after. */
+/**
+ * Removes a specific point from the path of control points.
+ * \note Requires #BKE_curveprofile_update call after.
+ */
 bool BKE_curveprofile_remove_point(CurveProfile *profile, CurveProfilePoint *point)
 {
   CurveProfilePoint *pts;
@@ -105,9 +107,13 @@ bool BKE_curveprofile_remove_point(CurveProfile *profile, CurveProfilePoint *poi
   return true;
 }
 
-/** Removes every point in the widget with the supplied flag set, except for the first and last.
- * \param flag: CurveProfilePoint->flag.
- * \note: Requires curveprofile_update call after. */
+/**
+ * Removes every point in the widget with the supplied flag set, except for the first and last.
+ *
+ * \param flag: #CurveProfilePoint.flag.
+ *
+ * \note Requires #BKE_curveprofile_update call after.
+ */
 void BKE_curveprofile_remove_by_flag(CurveProfile *profile, const short flag)
 {
   int i_old, i_new, n_removed = 0;
@@ -134,10 +140,13 @@ void BKE_curveprofile_remove_by_flag(CurveProfile *profile, const short flag)
   profile->path_len -= n_removed;
 }
 
-/** Adds a new point at the specified location. The choice for which points to place the new vertex
+/**
+ * Adds a new point at the specified location. The choice for which points to place the new vertex
  * between is made by checking which control point line segment is closest to the new point and
  * placing the new vertex in between that segment's points.
- * \note: Requires curveprofile_update call after. */
+ *
+ * \note Requires #BKE_curveprofile_update call after.
+ */
 CurveProfilePoint *BKE_curveprofile_insert(CurveProfile *profile, float x, float y)
 {
   CurveProfilePoint *new_pt = NULL;
@@ -202,7 +211,8 @@ CurveProfilePoint *BKE_curveprofile_insert(CurveProfile *profile, float x, float
 /**
  * Sets the handle type of the selected control points.
  * \param type_1, type_2: Either HD_VECT or HD_AUTO. Handle types for the first and second handles.
- * \note: Requires curveprofile_update call after.
+ *
+ * \note Requires #BKE_curveprofile_update call

@@ Diff output truncated at 10240 characters. @@



More information about the Bf-blender-cvs mailing list