[Bf-blender-cvs] [452df3f392e] master: Cleanup: comments
Campbell Barton
noreply at git.blender.org
Mon Feb 11 15:51:33 CET 2019
Commit: 452df3f392e29f5f44883bb9cd3bc0c4e8a0ee62
Author: Campbell Barton
Date: Tue Feb 12 01:21:09 2019 +1100
Branches: master
https://developer.blender.org/rB452df3f392e29f5f44883bb9cd3bc0c4e8a0ee62
Cleanup: comments
===================================================================
M release/windows/blendthumb/src/Dll.cpp
M source/blender/blenkernel/intern/DerivedMesh.c
M source/blender/blenkernel/intern/font.c
M source/blender/blenkernel/intern/library_idmap.c
M source/blender/blenkernel/intern/library_remap.c
M source/blender/blenkernel/intern/main.c
M source/blender/blenkernel/intern/mesh_runtime.c
M source/blender/blenlib/BLI_utildefines.h
M source/blender/blenloader/intern/readfile.c
M source/blender/bmesh/intern/bmesh_operator_api.h
M source/blender/bmesh/tools/bmesh_bevel.c
M source/blender/bmesh/tools/bmesh_intersect.c
M source/blender/depsgraph/intern/builder/deg_builder_nodes_rig.cc
M source/blender/editors/mesh/editmesh_tools.c
M source/blender/editors/space_image/image_buttons.c
M source/blender/editors/transform/transform_snap_object.c
M source/blender/makesdna/DNA_action_types.h
===================================================================
diff --git a/release/windows/blendthumb/src/Dll.cpp b/release/windows/blendthumb/src/Dll.cpp
index b59ef0fcb15..7b0521cd5a8 100644
--- a/release/windows/blendthumb/src/Dll.cpp
+++ b/release/windows/blendthumb/src/Dll.cpp
@@ -42,7 +42,7 @@ const CLASS_OBJECT_INIT c_rgClassObjectInit[] =
long g_cRefModule = 0;
-// Handle the the DLL's module
+// Handle the DLL's module
HINSTANCE g_hInst = NULL;
// Standard DLL functions
diff --git a/source/blender/blenkernel/intern/DerivedMesh.c b/source/blender/blenkernel/intern/DerivedMesh.c
index a0e85b99c02..d31fb72e4a0 100644
--- a/source/blender/blenkernel/intern/DerivedMesh.c
+++ b/source/blender/blenkernel/intern/DerivedMesh.c
@@ -460,7 +460,7 @@ void DM_ensure_normals(DerivedMesh *dm)
/**
* Ensure the array is large enough
*
- * /note This function must always be thread-protected by caller. It should only be used by internal code.
+ * \note This function must always be thread-protected by caller. It should only be used by internal code.
*/
void DM_ensure_looptri_data(DerivedMesh *dm)
{
diff --git a/source/blender/blenkernel/intern/font.c b/source/blender/blenkernel/intern/font.c
index ec8d4c8f75e..a1f9eaa3ac7 100644
--- a/source/blender/blenkernel/intern/font.c
+++ b/source/blender/blenkernel/intern/font.c
@@ -1261,7 +1261,6 @@ makebreak:
sb = &selboxes[i - selstart];
sb->rot = -ct->rot;
}
-
}
}
}
diff --git a/source/blender/blenkernel/intern/library_idmap.c b/source/blender/blenkernel/intern/library_idmap.c
index 3ab5cbaeef3..579465ce2fd 100644
--- a/source/blender/blenkernel/intern/library_idmap.c
+++ b/source/blender/blenkernel/intern/library_idmap.c
@@ -87,8 +87,8 @@ static struct IDNameLib_TypeMap *main_idmap_from_idcode(struct IDNameLib_Map *id
* #BKE_main_idmap_lookup_id will then check that given ID does exist in \a old_bmain
* before trying to use it.
*
- * \param create_valid_ids_set If \a true, generate a reference to prevent freed memory accesses.
- * \param old_bmain If not NULL, its IDs will be added the the valid references set.
+ * \param create_valid_ids_set: If \a true, generate a reference to prevent freed memory accesses.
+ * \param old_bmain: If not NULL, its IDs will be added the valid references set.
*/
struct IDNameLib_Map *BKE_main_idmap_create(
struct Main *bmain, const bool create_valid_ids_set, struct Main *old_bmain)
diff --git a/source/blender/blenkernel/intern/library_remap.c b/source/blender/blenkernel/intern/library_remap.c
index efd90634741..bbe8756b9c8 100644
--- a/source/blender/blenkernel/intern/library_remap.c
+++ b/source/blender/blenkernel/intern/library_remap.c
@@ -815,12 +815,12 @@ void BKE_libblock_free_datablock(ID *id, const int UNUSED(flag))
* However, they might still be using (referencing) other IDs, this code takes care of it if
* \a LIB_TAG_NO_USER_REFCOUNT is not defined.
*
- * \param bmain Main database containing the freed ID, can be NULL in case it's a temp ID outside of any Main.
- * \param idv Pointer to ID to be freed.
- * \param flag Set of \a LIB_ID_FREE_... flags controlling/overriding usual freeing process,
- * 0 to get default safe behavior.
- * \param use_flag_from_idtag Still use freeing info flags from given ID datablock,
- * even if some overriding ones are passed in \a falg parameter.
+ * \param bmain: Main database containing the freed ID, can be NULL in case it's a temp ID outside of any Main.
+ * \param idv: Pointer to ID to be freed.
+ * \param flag: Set of \a LIB_ID_FREE_... flags controlling/overriding usual freeing process,
+ * 0 to get default safe behavior.
+ * \param use_flag_from_idtag: Still use freeing info flags from given ID datablock,
+ * even if some overriding ones are passed in \a falg parameter.
*/
void BKE_id_free_ex(Main *bmain, void *idv, int flag, const bool use_flag_from_idtag)
{
@@ -910,8 +910,8 @@ void BKE_id_free_ex(Main *bmain, void *idv, int flag, const bool use_flag_from_i
*
* See #BKE_id_free_ex description for full details.
*
- * \param bmain Main database containing the freed ID, can be NULL in case it's a temp ID outside of any Main.
- * \param idv Pointer to ID to be freed.
+ * \param bmain: Main database containing the freed ID, can be NULL in case it's a temp ID outside of any Main.
+ * \param idv: Pointer to ID to be freed.
*/
void BKE_id_free(Main *bmain, void *idv)
{
diff --git a/source/blender/blenkernel/intern/main.c b/source/blender/blenkernel/intern/main.c
index 37d812adfa2..11150f827e2 100644
--- a/source/blender/blenkernel/intern/main.c
+++ b/source/blender/blenkernel/intern/main.c
@@ -19,7 +19,7 @@
/** \file \ingroup bke
*
- * Contains management of Main database itself.
+ * Contains management of #Main database itself.
*/
#include <string.h>
@@ -219,7 +219,7 @@ static bool main_gset_create(Main *UNUSED(bmain), ID *id, void *user_data)
/**
* Create a GSet storing all IDs present in given \a bmain, by their pointers.
*
- * \param gset If not NULL, given GSet will be extended with IDs from given \a bmain, instead of creating a new one.
+ * \param gset: If not NULL, given GSet will be extended with IDs from given \a bmain, instead of creating a new one.
*/
GSet *BKE_main_gset_create(Main *bmain, GSet *gset)
{
@@ -253,10 +253,9 @@ bool BKE_main_listbase_foreach_id(
/**
* Call given callback over every IDs of given \a bmain Main database.
*
- * \param reverse_type_order Allow to reverse order in which ID *types* are handled
- * (i.e. does not reverse the order in which IDs themselves are handled
- * whithin a give listbase).
- * Note that in most cases, you want to set that parameter to true.
+ * \param reverse_type_order: Allow to reverse order in which ID *types* are handled
+ * (i.e. does not reverse the order in which IDs themselves are handled whithin a give listbase).
+ * Note that in most cases, you want to set that parameter to true.
* \return false if the iteration was iterrupted by the callback.
*
* \warning \a callback may affect the ID, but DO NOT change the Main database (add/remove/reorder its IDs).
@@ -357,7 +356,7 @@ const char *BKE_main_blendfile_path(const Main *bmain)
}
/**
- * Return filepath of global main (G_MAIN).
+ * Return filepath of global main #G_MAIN.
*
* \warning Usage is not recommended, you should always try to get a valid Main pointer from context...
*/
@@ -449,12 +448,12 @@ ListBase *which_libbase(Main *bmain, short type)
}
/**
- * puts into array *lb pointers to all the ListBase structs in main,
+ * puts into array *lb pointers to all the #ListBase structs in main,
* and returns the number of them as the function result. This is useful for
* generic traversal of all the blocks in a Main (by traversing all the
* lists in turn), without worrying about block types.
*
- * \note MAX_LIBARRAY define should match this code */
+ * \note #MAX_LIBARRAY define should match this code */
int set_listbasepointers(Main *bmain, ListBase **lb)
{
/* BACKWARDS! also watch order of free-ing! (mesh<->mat), first items freed last.
diff --git a/source/blender/blenkernel/intern/mesh_runtime.c b/source/blender/blenkernel/intern/mesh_runtime.c
index 2fe6f435367..788558e5378 100644
--- a/source/blender/blenkernel/intern/mesh_runtime.c
+++ b/source/blender/blenkernel/intern/mesh_runtime.c
@@ -76,7 +76,7 @@ void BKE_mesh_runtime_clear_cache(Mesh *mesh)
/**
* Ensure the array is large enough
*
- * /note This function must always be thread-protected by caller. It should only be used by internal code.
+ * \note This function must always be thread-protected by caller. It should only be used by internal code.
*/
static void mesh_ensure_looptri_data(Mesh *mesh)
{
diff --git a/source/blender/blenlib/BLI_utildefines.h b/source/blender/blenlib/BLI_utildefines.h
index 2553ec7d8b0..cf8e393ca98 100644
--- a/source/blender/blenlib/BLI_utildefines.h
+++ b/source/blender/blenlib/BLI_utildefines.h
@@ -587,7 +587,7 @@ extern bool BLI_memory_is_zero(const void *arr, const size_t arr_size);
/* Expands to an integer constant expression evaluating to a close upper bound
* on the number the number of decimal digits in a value expressible in the
- * integer type given by the argument (if it is a type name) or the the integer
+ * integer type given by the argument (if it is a type name) or the integer
* type of the argument (if it is an expression). The meaning of the resulting
* expression is unspecified for other arguments.
* i.e: DECIMAL_DIGITS_BOUND(uchar) is equal to 3. */
diff --git a/source/blender/blenloader/intern/readfile.c b/source/blender/blenloader/intern/readfile.c
index adef6e4dc2d..c4fdb878b86 100644
--- a/source/blender/blenloader/intern/readfile.c
+++ b/source/blender/blenloader/intern/readfile.c
@@ -10953,7 +10953,7 @@ static void read_libraries(FileData *basefd, ListBase *mainlist)
change_idid_adr(mainlist, basefd, id, *realid);
/* We cannot free old lib-ref placeholder ID here anymore, since we use its name
- * as key in loaded_ids hass. */
+ * as key in loaded_ids has. */
BLI_addtail(&pending_free_ids, id);
}
id = idn;
diff --git a/source/blender/bmesh/intern/bmesh_operator_api.h b/source/blender/bmesh/intern/bmesh_operator_api.h
index 2aedc204f9a..cbfe0b6b4a5 100644
--- a/source/blender/bmesh/intern/bmesh_operator_api.h
+++ b/source/blender/bmesh/intern/bmesh_operator_api.h
@@ -521,7 +521,7 @@ void BMO_slot_buffer_from_all(
*
* f = BMO_iter_new(&oiter, some_operator, "slot_name", BM_FACE);
* for (; f; f = BMO_iter_step(&oiter)) {
- * /do something with the face
+ * // do something with the face
* }
*
* another example, iterating over a mapping:
diff --git a/source/blender/bmesh/tools/bmesh_bevel.c b/source/blender/bmesh/tools/bmesh_bevel.c
index cb1bbc0efc3..5d9963fd4c0 100644
--- a/source/blender/bmesh/tools/bmesh_bevel.c
+++ b/source/blender/bmesh/tools/bmesh_bevel.c
@@ -1777,11 +1777,11 @@ static void bevel_edges_sharp_boundary(BMesh *bm, BevelParams *bp)
}
}
-/*
+/**
* Harden normals for bevel.
- * The desir
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list