[Bf-blender-cvs] [5777bd719b0] master: Cleanup: use doxygen comments, correct spelling
Campbell Barton
noreply at git.blender.org
Mon Feb 28 23:43:40 CET 2022
Commit: 5777bd719b01f56e52d618a3260bd4cdf223d5cd
Author: Campbell Barton
Date: Tue Mar 1 09:09:24 2022 +1100
Branches: master
https://developer.blender.org/rB5777bd719b01f56e52d618a3260bd4cdf223d5cd
Cleanup: use doxygen comments, correct spelling
Also move eDupli_ID_Flags doc-string to it's declaration.
===================================================================
M intern/ghost/intern/GHOST_SystemWin32.cpp
M source/blender/blenkernel/intern/blendfile_link_append.c
M source/blender/blenkernel/intern/mesh_validate.cc
M source/blender/blenkernel/intern/subdiv_modifier.c
M source/blender/editors/include/ED_anim_api.h
M source/blender/editors/include/ED_keyframes_keylist.h
M source/blender/editors/interface/interface.c
M source/blender/editors/interface/interface_widgets.c
M source/blender/editors/mesh/editmesh_tools.c
M source/blender/editors/object/object_add.cc
M source/blender/editors/object/object_edit.c
M source/blender/editors/space_file/filelist.c
M source/blender/makesdna/DNA_userdef_enums.h
M source/blender/makesrna/intern/rna_access_compare_override.c
M source/blender/nodes/geometry/nodes/node_geo_duplicate_elements.cc
===================================================================
diff --git a/intern/ghost/intern/GHOST_SystemWin32.cpp b/intern/ghost/intern/GHOST_SystemWin32.cpp
index fa93324e0b3..e588c7485b4 100644
--- a/intern/ghost/intern/GHOST_SystemWin32.cpp
+++ b/intern/ghost/intern/GHOST_SystemWin32.cpp
@@ -654,7 +654,7 @@ GHOST_TKey GHOST_SystemWin32::processSpecialKey(short vKey, short scanCode) cons
}
else if (vKey == VK_OEM_8) {
if (PRIMARYLANGID(m_langId) == LANG_FRENCH) {
- /* oem key; used purely for shortcuts. */
+ /* OEM key; used purely for shortcuts. */
key = GHOST_kKeyF13;
}
}
diff --git a/source/blender/blenkernel/intern/blendfile_link_append.c b/source/blender/blenkernel/intern/blendfile_link_append.c
index 862266b696c..ce36bfe81be 100644
--- a/source/blender/blenkernel/intern/blendfile_link_append.c
+++ b/source/blender/blenkernel/intern/blendfile_link_append.c
@@ -930,9 +930,9 @@ static int foreach_libblock_link_append_callback(LibraryIDLinkCallbackData *cb_d
* shape-key referencing the shape-key itself).
* NOTE: in case both IDs (owner and 'used' ones) are non-linkable, we can assume we can break
* the dependency here. Indeed, either they are both linked in another way (through their own
- * meshes for shape keys e.g.), or this is an unsupported case (two shapekeys depending on
- * each-other need to be also 'linked' in by their respective meshes, independant shapekeys are
- * not allowed). ref T96048. */
+ * meshes for shape keys e.g.), or this is an unsupported case (two shape-keys depending on
+ * each-other need to be also 'linked' in by their respective meshes, independent shape-keys
+ * are not allowed). ref T96048. */
if (id != cb_data->id_self && BKE_idtype_idcode_is_linkable(GS(cb_data->id_self->name))) {
BKE_library_foreach_ID_link(
cb_data->bmain, id, foreach_libblock_link_append_callback, data, IDWALK_NOP);
@@ -1454,7 +1454,7 @@ void BKE_blendfile_library_relocate(BlendfileLinkAppendContext *lapp_context,
BlendfileLinkAppendContextItem *item;
/* We remove it from current Main, and add it to items to link... */
- /* Note that non-linkable IDs (like e.g. shapekeys) are also explicitly linked here... */
+ /* Note that non-linkable IDs (like e.g. shape-keys) are also explicitly linked here... */
BLI_remlink(lbarray[lba_idx], id);
/* Usual special code for ShapeKeys snowflakes... */
Key *old_key = BKE_key_from_id(id);
diff --git a/source/blender/blenkernel/intern/mesh_validate.cc b/source/blender/blenkernel/intern/mesh_validate.cc
index cc7404e2a11..fb526354305 100644
--- a/source/blender/blenkernel/intern/mesh_validate.cc
+++ b/source/blender/blenkernel/intern/mesh_validate.cc
@@ -1437,7 +1437,7 @@ static void mesh_calc_edges_mdata(MVert *UNUSED(allvert),
med++;
}
else {
- /* equal edge, we merge the drawflag */
+ /* Equal edge, merge the draw-flag. */
(ed + 1)->is_draw |= ed->is_draw;
}
}
diff --git a/source/blender/blenkernel/intern/subdiv_modifier.c b/source/blender/blenkernel/intern/subdiv_modifier.c
index 95a5946d7d3..34dfdaf7595 100644
--- a/source/blender/blenkernel/intern/subdiv_modifier.c
+++ b/source/blender/blenkernel/intern/subdiv_modifier.c
@@ -89,7 +89,7 @@ bool BKE_subsurf_modifier_force_disable_gpu_evaluation_for_mesh(const SubsurfMod
const Mesh *mesh)
{
if ((U.gpu_flag & USER_GPU_FLAG_SUBDIVISION_EVALUATION) == 0) {
- /* GPU subdivision is explicitely disabled, so we don't force it. */
+ /* GPU subdivision is explicitly disabled, so we don't force it. */
return false;
}
diff --git a/source/blender/editors/include/ED_anim_api.h b/source/blender/editors/include/ED_anim_api.h
index 3e045c9c43a..4b6f5e4cac6 100644
--- a/source/blender/editors/include/ED_anim_api.h
+++ b/source/blender/editors/include/ED_anim_api.h
@@ -1090,11 +1090,11 @@ void animviz_calc_motionpaths(struct Depsgraph *depsgraph,
bool restore);
/**
- * Update motion path computation range (in ob.avs or armature.avs) from user choice in
- * ob.avs.path_range or arm.avs.path_range, depending on active user mode.
+ * Update motion path computation range (in `ob.avs` or `armature.avs`) from user choice in
+ * `ob.avs.path_range` or `arm.avs.path_range`, depending on active user mode.
*
- * @param ob: Object to compute range for (must be provided)
- * @param scene: Used when scene range is choosen
+ * \param ob: Object to compute range for (must be provided).
+ * \param scene: Used when scene range is chosen.
*/
void animviz_motionpath_compute_range(struct Object *ob, struct Scene *scene);
diff --git a/source/blender/editors/include/ED_keyframes_keylist.h b/source/blender/editors/include/ED_keyframes_keylist.h
index 39f050c9739..fd3d35e1df7 100644
--- a/source/blender/editors/include/ED_keyframes_keylist.h
+++ b/source/blender/editors/include/ED_keyframes_keylist.h
@@ -132,8 +132,10 @@ const struct ActKeyColumn *ED_keylist_find_any_between(const struct AnimKeylist
bool ED_keylist_is_empty(const struct AnimKeylist *keylist);
const struct ListBase /* ActKeyColumn */ *ED_keylist_listbase(const struct AnimKeylist *keylist);
bool ED_keylist_all_keys_frame_range(const struct AnimKeylist *keylist, Range2f *r_frame_range);
-/* Return the selected keyframe's range. If none are selected, return False and does not affect
- * the frame range. */
+/**
+ * Return the selected key-frame's range.
+ * \return False If none are selected and does not affect the frame range.
+ */
bool ED_keylist_selected_keys_frame_range(const struct AnimKeylist *keylist,
Range2f *r_frame_range);
const ActKeyColumn *ED_keylist_array(const struct AnimKeylist *keylist);
@@ -187,10 +189,10 @@ void mask_to_keylist(struct bDopeSheet *ads,
/* ActKeyColumn API ---------------- */
-/* Checks if ActKeyColumn has any block data */
+/** Checks if #ActKeyColumn has any block data. */
bool actkeyblock_is_valid(const ActKeyColumn *ac);
-/* Checks if ActKeyColumn can be used as a block (i.e. drawn/used to detect "holds") */
+/** Checks if #ActKeyColumn can be used as a block (i.e. drawn/used to detect "holds"). */
int actkeyblock_get_valid_hold(const ActKeyColumn *ac);
#ifdef __cplusplus
diff --git a/source/blender/editors/interface/interface.c b/source/blender/editors/interface/interface.c
index a9a68be2d48..bbd2a64bab4 100644
--- a/source/blender/editors/interface/interface.c
+++ b/source/blender/editors/interface/interface.c
@@ -3087,11 +3087,11 @@ bool ui_but_string_set(bContext *C, uiBut *but, const char *str)
PointerRNA rptr;
/* This is kind of hackish, in theory think we could only ever use the second member of
- * this if/else, since ui_searchbox_apply() is supposed to always set that pointer when
+ * this if/else, since #ui_searchbox_apply() is supposed to always set that pointer when
* we are storing pointers... But keeping str search first for now,
* to try to break as little as possible existing code. All this is band-aids anyway.
- * Fact remains, using editstr as main 'reference' over whole search button thingy
- * is utterly weak and should be redesigned imho, but that's not a simple task. */
+ * Fact remains, using `editstr` as main 'reference' over whole search button thingy
+ * is utterly weak and should be redesigned IMHO, but that's not a simple task. */
if (search_but && search_but->rnasearchprop &&
RNA_property_collection_lookup_string(
&search_but->rnasearchpoin, search_but->rnasearchprop, str, &rptr)) {
diff --git a/source/blender/editors/interface/interface_widgets.c b/source/blender/editors/interface/interface_widgets.c
index 5638a98b33b..d1f3843c643 100644
--- a/source/blender/editors/interface/interface_widgets.c
+++ b/source/blender/editors/interface/interface_widgets.c
@@ -4293,7 +4293,7 @@ static void widget_tab(
const bool is_active = (state & UI_SELECT);
/* Draw shaded outline - Disabled for now,
- * seems incorrect and also looks nicer without it imho ;) */
+ * seems incorrect and also looks nicer without it IMHO ;). */
// #define USE_TAB_SHADED_HIGHLIGHT
uchar theme_col_tab_highlight[3];
diff --git a/source/blender/editors/mesh/editmesh_tools.c b/source/blender/editors/mesh/editmesh_tools.c
index 9757dd1367f..2577218d6a9 100644
--- a/source/blender/editors/mesh/editmesh_tools.c
+++ b/source/blender/editors/mesh/editmesh_tools.c
@@ -9641,13 +9641,13 @@ static int edbm_smooth_normals_exec(bContext *C, wmOperator *op)
float(*smooth_normal)[3] = MEM_callocN(sizeof(*smooth_normal) * lnors_ed_arr->totloop,
__func__);
- /* This is weird choice of operation, taking all loops of faces of current vertex.
- * Could lead to some rather far away loops weighting as much as very close ones
+ /* NOTE(@mont29): This is weird choice of operation, taking all loops of faces of current
+ * vertex. Could lead to some rather far away loops weighting as much as very close ones
* (topologically speaking), with complex polygons.
* Using topological distance here (rather than geometrical one)
- * makes sense imho, but would rather go with a more consistent and flexible code,
- * we could even add max topological distance to take into account, * and a weighting curve.
- * Would do that later though, think for now we can live with that choice. --mont29. */
+ * makes sense IMHO, but would rather go with a more consistent and flexible code,
+ * we could even add max topological distance to take into account, and a weighting curve.
+ * Would do that later though, think for now we can live with that choice. */
BMLoopNorEditData *lnor_ed = lnors_ed_arr->lnor_editdata;
for (int i = 0; i < lnors_ed_arr->totloop; i++, lnor_ed++) {
l = lnor_ed->loop;
diff --git a/source/blender/editors/object/object_add.cc b/source/blender/editors/object/object_add.cc
index ef11337254c..19db09961e8 100644
--- a/
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list