[Bf-blender-cvs] [eff8cc9cccd] master: Cleanup: doxy comments
Campbell Barton
noreply at git.blender.org
Sun Apr 14 10:50:29 CEST 2019
Commit: eff8cc9cccdaa7248d9d869473704e9db69c2f41
Author: Campbell Barton
Date: Sun Apr 14 10:48:42 2019 +0200
Branches: master
https://developer.blender.org/rBeff8cc9cccdaa7248d9d869473704e9db69c2f41
Cleanup: doxy comments
Use doxy references to function and enums,
also correct some names which became out of sync.
===================================================================
M intern/ghost/intern/GHOST_SystemCocoa.mm
M intern/ghost/intern/GHOST_SystemWin32.cpp
M source/blender/blenfont/intern/blf_font.c
M source/blender/blenkernel/BKE_blender_version.h
M source/blender/blenkernel/intern/armature.c
M source/blender/blenkernel/intern/collection.c
M source/blender/blenkernel/intern/constraint.c
M source/blender/blenkernel/intern/crazyspace.c
M source/blender/blenkernel/intern/image.c
M source/blender/blenkernel/intern/library_query.c
M source/blender/blenkernel/intern/mesh_validate.c
M source/blender/blenkernel/intern/object.c
M source/blender/blenkernel/intern/object_update.c
M source/blender/blenkernel/intern/pbvh.c
M source/blender/blenkernel/intern/softbody.c
M source/blender/blenkernel/intern/tracking_stabilize.c
M source/blender/blenlib/intern/BLI_ghash.c
M source/blender/blenlib/intern/edgehash.c
M source/blender/blenlib/intern/math_matrix.c
M source/blender/blenlib/intern/winstuff_dir.c
M source/blender/blenloader/intern/readfile.c
M source/blender/collada/BCAnimationSampler.cpp
M source/blender/draw/modes/pose_mode.c
M source/blender/editors/animation/keyframes_general.c
M source/blender/editors/animation/keyframing.c
M source/blender/editors/armature/armature_utils.c
M source/blender/editors/curve/editcurve.c
M source/blender/editors/gpencil/gpencil_utils.c
M source/blender/editors/include/ED_keyframing.h
M source/blender/editors/include/ED_numinput.h
M source/blender/editors/interface/interface_align.c
M source/blender/editors/lattice/editlattice_tools.c
M source/blender/editors/space_clip/clip_editor.c
M source/blender/editors/space_text/text_draw.c
M source/blender/editors/space_text/text_format_lua.c
M source/blender/editors/space_text/text_format_pov.c
M source/blender/editors/space_text/text_format_pov_ini.c
M source/blender/editors/space_text/text_format_py.c
M source/blender/editors/space_view3d/view3d_iterators.c
M source/blender/editors/space_view3d/view3d_project.c
M source/blender/editors/uvedit/uvedit_ops.c
M source/blender/gpu/GPU_immediate.h
M source/blender/gpu/intern/gpu_uniformbuffer.c
M source/blender/makesdna/DNA_anim_types.h
M source/blender/makesdna/DNA_object_force_types.h
M source/blender/makesdna/intern/dna_genfile.c
M source/blender/makesrna/intern/rna_access.c
M source/blender/render/intern/source/multires_bake.c
M source/blender/windowmanager/intern/wm_event_system.c
M source/blender/windowmanager/intern/wm_init_exit.c
===================================================================
diff --git a/intern/ghost/intern/GHOST_SystemCocoa.mm b/intern/ghost/intern/GHOST_SystemCocoa.mm
index b847cace57c..8b270c1d972 100644
--- a/intern/ghost/intern/GHOST_SystemCocoa.mm
+++ b/intern/ghost/intern/GHOST_SystemCocoa.mm
@@ -648,7 +648,7 @@ GHOST_IWindow* GHOST_SystemCocoa::createWindow(
/**
* Create a new offscreen context.
- * Never explicitly delete the context, use disposeContext() instead.
+ * Never explicitly delete the context, use #disposeContext() instead.
* \return The new context (or 0 if creation failed).
*/
GHOST_IContext *
diff --git a/intern/ghost/intern/GHOST_SystemWin32.cpp b/intern/ghost/intern/GHOST_SystemWin32.cpp
index 12d58b0a9cb..35a9cfac817 100644
--- a/intern/ghost/intern/GHOST_SystemWin32.cpp
+++ b/intern/ghost/intern/GHOST_SystemWin32.cpp
@@ -304,8 +304,8 @@ GHOST_IWindow *GHOST_SystemWin32::createWindow(
/**
* Create a new offscreen context.
- * Never explicitly delete the window, use disposeContext() instead.
- * \return The new context (or 0 if creation failed).
+ * Never explicitly delete the window, use #disposeContext() instead.
+ * \return The new context (or 0 if creation failed).
*/
GHOST_IContext *GHOST_SystemWin32::createOffscreenContext()
{
diff --git a/source/blender/blenfont/intern/blf_font.c b/source/blender/blenfont/intern/blf_font.c
index 9f81c41bd2d..06904ee36b6 100644
--- a/source/blender/blenfont/intern/blf_font.c
+++ b/source/blender/blenfont/intern/blf_font.c
@@ -74,11 +74,12 @@ static SpinLock ft_lib_mutex;
/* -------------------------------------------------------------------- */
/** \name Glyph Batching
* \{ */
+
/**
* Drawcalls are precious! make them count!
* Since most of the Text elems are not covered by other UI elements, we can
* group some strings together and render them in one drawcall. This behavior
- * is on demand only, between BLF_batch_start() and BLF_batch_end().
+ * is on demand only, between #BLF_batch_draw_begin() and #BLF_batch_draw_end().
*/
static void blf_batch_draw_init(void)
{
diff --git a/source/blender/blenkernel/BKE_blender_version.h b/source/blender/blenkernel/BKE_blender_version.h
index 9c47cc9f22b..1b56e203947 100644
--- a/source/blender/blenkernel/BKE_blender_version.h
+++ b/source/blender/blenkernel/BKE_blender_version.h
@@ -20,21 +20,25 @@
* \ingroup bke
*/
-/* these lines are grep'd, watch out for our not-so-awesome regex
- * and keep comment above the defines.
- * Use STRINGIFY() rather than defining with quotes */
+/**
+ * The lines below use regex from scripts to extract their values,
+ * Keep this in mind when modifying this file and keep this comment above the defines.
+ *
+ * \note Use #STRINGIFY() rather than defining with quotes.
+ */
#define BLENDER_VERSION 280
#define BLENDER_SUBVERSION 55
-/* Several breakages with 280, e.g. collections vs layers */
+/** Several breakages with 280, e.g. collections vs layers. */
#define BLENDER_MINVERSION 280
#define BLENDER_MINSUBVERSION 0
-/* used by packaging tools */
-/* can be left blank, otherwise a,b,c... etc with no quotes */
+/** Used by packaging tools. */
+/** Can be left blank, otherwise a,b,c... etc with no quotes. */
#define BLENDER_VERSION_CHAR
-/* alpha/beta/rc/release, docs use this */
+/** alpha/beta/rc/release, docs use this. */
#define BLENDER_VERSION_CYCLE beta
-extern char versionstr[]; /* from blender.c */
+/** Defined in from blender.c */
+extern char versionstr[];
#endif /* __BKE_BLENDER_VERSION_H__ */
diff --git a/source/blender/blenkernel/intern/armature.c b/source/blender/blenkernel/intern/armature.c
index 5123b159440..890a62351c1 100644
--- a/source/blender/blenkernel/intern/armature.c
+++ b/source/blender/blenkernel/intern/armature.c
@@ -1714,7 +1714,9 @@ void BKE_armature_mat_pose_to_bone_ex(struct Depsgraph *depsgraph, Object *ob, b
BKE_armature_mat_pose_to_bone(&work_pchan, inmat, outmat);
}
-/* same as BKE_object_mat3_to_rot() */
+/**
+ * Same as #BKE_object_mat3_to_rot().
+ */
void BKE_pchan_mat3_to_rot(bPoseChannel *pchan, float mat[3][3], bool use_compat)
{
BLI_ASSERT_UNIT_M3(mat);
@@ -1735,8 +1737,10 @@ void BKE_pchan_mat3_to_rot(bPoseChannel *pchan, float mat[3][3], bool use_compat
}
}
-/* Apply a 4x4 matrix to the pose bone,
- * similar to BKE_object_apply_mat4() */
+/**
+ * Apply a 4x4 matrix to the pose bone,
+ * similar to #BKE_object_apply_mat4().
+ */
void BKE_pchan_apply_mat4(bPoseChannel *pchan, float mat[4][4], bool use_compat)
{
float rot[3][3];
@@ -1744,9 +1748,11 @@ void BKE_pchan_apply_mat4(bPoseChannel *pchan, float mat[4][4], bool use_compat)
BKE_pchan_mat3_to_rot(pchan, rot, use_compat);
}
-/* Remove rest-position effects from pose-transform for obtaining
+/**
+ * Remove rest-position effects from pose-transform for obtaining
* 'visual' transformation of pose-channel.
- * (used by the Visual-Keyframing stuff) */
+ * (used by the Visual-Keyframing stuff).
+ */
void BKE_armature_mat_pose_to_delta(float delta_mat[4][4], float pose_mat[4][4], float arm_mat[4][4])
{
float imat[4][4];
diff --git a/source/blender/blenkernel/intern/collection.c b/source/blender/blenkernel/intern/collection.c
index 336a4739760..eadf190c363 100644
--- a/source/blender/blenkernel/intern/collection.c
+++ b/source/blender/blenkernel/intern/collection.c
@@ -804,7 +804,7 @@ static void collection_missing_parents_remove(Collection *collection)
* This is used for library remapping, where these pointers have been set to NULL.
* Otherwise this should never happen.
*
- * \note caller must ensure BKE_main_collection_sync_remap() is called afterwards!
+ * \note caller must ensure #BKE_main_collection_sync_remap() is called afterwards!
*
* \param collection: may be \a NULL, in which case whole \a bmain database of collections is checked.
*/
diff --git a/source/blender/blenkernel/intern/constraint.c b/source/blender/blenkernel/intern/constraint.c
index 7d9a6c234a0..e8a4983528e 100644
--- a/source/blender/blenkernel/intern/constraint.c
+++ b/source/blender/blenkernel/intern/constraint.c
@@ -4709,15 +4709,18 @@ const bConstraintTypeInfo *BKE_constraint_typeinfo_get(bConstraint *con)
/* ---------- Data Management ------- */
-/* helper function for BKE_constraint_free_data() - unlinks references */
+/**
+ * Helper function for #BKE_constraint_free_data() - unlinks references.
+ */
static void con_unlink_refs_cb(bConstraint *UNUSED(con), ID **idpoin, bool is_reference, void *UNUSED(userData))
{
if (*idpoin && is_reference)
id_us_min(*idpoin);
}
-/* Free data of a specific constraint if it has any info.
- * be sure to run BIK_clear_data() when freeing an IK constraint,
+/**
+ * Free data of a specific constraint if it has any info.
+ * be sure to run #BIK_clear_data() when freeing an IK constraint,
* unless DAG_relations_tag_update is called.
*/
void BKE_constraint_free_data_ex(bConstraint *con, bool do_id_user)
diff --git a/source/blender/blenkernel/intern/crazyspace.c b/source/blender/blenkernel/intern/crazyspace.c
index 5dd5e014cc8..4aa3b702693 100644
--- a/source/blender/blenkernel/intern/crazyspace.c
+++ b/source/blender/blenkernel/intern/crazyspace.c
@@ -305,12 +305,13 @@ int BKE_crazyspace_get_first_deform_matrices_editbmesh(
return numleft;
}
-/* Crazyspace evaluation needs to have an object which has all the fields
+/**
+ * Crazyspace evaluation needs to have an object which has all the fields
* evaluated, but the mesh data being at undeformed state. This way it can
* re-apply modifiers and also have proper pointers to key data blocks.
*
- * Similar to BKE_object_eval_reset(), but does not modify the actual evaluated
- * object. */
+ * Similar to #BKE_object_eval_reset(), but does not modify the actual evaluated object.
+ */
static void crazyspace_init_object_for_eval(
struct Depsgraph *depsgraph,
Object *object,
diff --git a/source/blender/blenkernel/intern/image.c b/source/blender/blenkernel/intern/image.c
index b00e4cbcdd9..0205f275f59 100644
--- a/source/blender/blenkernel/intern/image.c
+++ b/source/blender/blenkernel/intern/image.c
@@ -4770,8 +4770,9 @@ bool BKE_image_has_loaded_ibuf(Image *image)
return has_loaded_ibuf;
}
-/* References the result, BKE_image_release_ibuf is to be called to de-reference.
- * Use lock=NULL when calling BKE_image_release_ibuf().
+/**
+ * References the result, #BKE_image_release_ibuf is to be called to de-reference.
+ * Use lock=NULL when calling #BKE_image_release_ibuf().
*/
ImBuf *BKE_image_get_ibuf_with_name(Image *image, const char *name)
{
@@ -4797,8 +4798,9 @@ ImBuf *BKE_image_get_ibuf_with_name(Image *image, const char *name)
return ibuf;
}
-/* References the result, BKE_image_release_ibuf is to be called to de-reference.
- * Use lock=NULL when calling BKE_image_release_ibuf().
+/**
+ * References the result, #BKE_image_release_ibuf is to be called to de-reference.
+ * Use lock=NULL when calling #BKE_image_release_ibuf().
*
* TODO(sergey): This is actually "get first entry from the cache", which is
* not so much predictable. But using first loaded image buffer
diff --git a/source/blender/blenkernel/intern/library_query.c b/source/blender/blenkernel/intern/library_query.c
index 4fc1ea6bb62..b7ae8eea18d 100644
--- a/source/blender/blenkernel/intern/library_query.c
+++ b/source/blender/blenkernel/intern/library_query.c
@@ -1294,7 +1294,7 @@ bool BKE_library_ID_is_indirectly_used(Main *bmain, void *idv)
}
/**
- * Combine \a BKE_library_ID_is_locally_used() and \a BKE_library_ID_is_indirectly_used() in a single call.
+ * Combine #BKE_library_ID_is_locally_used() and #BKE_library_ID_is_indirectly_used() in a single call.
*/
void BKE_library_ID_test_usages(Main *bmain, void *idv, bool *is_used_local, bool *is_used_linked)
{
diff --git a/source/blender/blenkernel/intern/mesh_validate.c b/source/blender/blenkernel/intern/mesh_validate.c
index a5aa198bc4e..295b65190a8 100644
--- a/source/blender/blenkernel/intern/mesh_validate.c
+++ b/source/blender/blenkernel/intern/mesh_validate.c
@@ -1063,10 +1063,13 @@ void BKE_mesh_strip_loose_faces(Mesh *me)
}
}
-/* Works on both loops and polys! */
-/* Note: It won't try to guess which loops of an invalid
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list