[Bf-blender-cvs] [5e47056e8d9] master: Cleanup: malformed C-style comment blocks, spelling
Campbell Barton
noreply at git.blender.org
Mon Apr 11 04:07:25 CEST 2022
Commit: 5e47056e8d97e414c9dabacea71fac2bdc7d2818
Author: Campbell Barton
Date: Mon Apr 11 11:41:00 2022 +1000
Branches: master
https://developer.blender.org/rB5e47056e8d97e414c9dabacea71fac2bdc7d2818
Cleanup: malformed C-style comment blocks, spelling
- Missing star prefix.
- Unnecessary indentation.
- Blank line after dot-points
(otherwise doxygen merges with the previous dot-point).
- Use back-slash for doxygen commands.
- Correct spelling.
===================================================================
M source/blender/blenkernel/BKE_armature.h
M source/blender/blenkernel/BKE_callbacks.h
M source/blender/blenkernel/BKE_cryptomatte.hh
M source/blender/blenkernel/BKE_fcurve.h
M source/blender/blenkernel/BKE_gpencil_update_cache.h
M source/blender/blenkernel/BKE_node.h
M source/blender/blenkernel/BKE_rigidbody.h
M source/blender/blenkernel/intern/constraint.c
M source/blender/blenkernel/intern/type_conversions.cc
M source/blender/blenlib/BLI_delaunay_2d.h
M source/blender/blenlib/BLI_fileops.h
M source/blender/blenlib/BLI_mesh_intersect.hh
M source/blender/blenlib/BLI_string.h
M source/blender/blenlib/intern/delaunay_2d.cc
M source/blender/blenlib/intern/math_boolean.cc
M source/blender/depsgraph/intern/eval/deg_eval_copy_on_write.cc
M source/blender/draw/engines/image/image_space.hh
M source/blender/draw/engines/workbench/shaders/infos/workbench_prepass_info.hh
M source/blender/editors/armature/pose_slide.c
M source/blender/editors/asset/intern/asset_list.cc
M source/blender/editors/include/ED_uvedit.h
M source/blender/editors/interface/interface_intern.h
M source/blender/editors/render/render_shading.cc
M source/blender/editors/sculpt_paint/sculpt_intern.h
M source/blender/editors/sculpt_paint/sculpt_paint_color.c
M source/blender/freestyle/intern/view_map/Interface1D.h
M source/blender/functions/FN_multi_function_builder.hh
M source/blender/gpencil_modifiers/intern/MOD_gpencilenvelope.c
M source/blender/io/usd/intern/usd_reader_material.h
M source/blender/makesdna/DNA_ID.h
M source/blender/makesrna/intern/rna_internal.h
M source/blender/makesrna/intern/rna_internal_types.h
M source/blender/nodes/NOD_math_functions.hh
M source/blender/nodes/NOD_socket_search_link.hh
M source/blender/nodes/geometry/nodes/node_geo_dual_mesh.cc
M source/blender/python/BPY_extern_run.h
M source/blender/python/intern/bpy.c
M source/blender/sequencer/intern/image_cache.c
===================================================================
diff --git a/source/blender/blenkernel/BKE_armature.h b/source/blender/blenkernel/BKE_armature.h
index 6765fb3ef08..888de38dcc7 100644
--- a/source/blender/blenkernel/BKE_armature.h
+++ b/source/blender/blenkernel/BKE_armature.h
@@ -165,7 +165,7 @@ void BKE_pchan_minmax(const struct Object *ob,
float r_max[3]);
/**
* Calculate the axis aligned bounds of the pose of `ob` in world-space.
-
+ *
* `r_min` and `r_max` are expanded to fit `ob->pose` so the caller must initialize them
* (typically using #INIT_MINMAX).
*
diff --git a/source/blender/blenkernel/BKE_callbacks.h b/source/blender/blenkernel/BKE_callbacks.h
index 2cd28c4dfa5..8b2af96a063 100644
--- a/source/blender/blenkernel/BKE_callbacks.h
+++ b/source/blender/blenkernel/BKE_callbacks.h
@@ -16,7 +16,7 @@ struct Main;
struct PointerRNA;
/**
- Callbacks for One Off Actions
+ * Callbacks for One Off Actions
* =============================
*
* - `{ACTION}` use in cases where only a single callback is required,
diff --git a/source/blender/blenkernel/BKE_cryptomatte.hh b/source/blender/blenkernel/BKE_cryptomatte.hh
index 0c576e5e48e..cd3f8dc9f58 100644
--- a/source/blender/blenkernel/BKE_cryptomatte.hh
+++ b/source/blender/blenkernel/BKE_cryptomatte.hh
@@ -59,7 +59,7 @@ struct CryptomatteHash {
std::string hex_encoded() const;
/**
- Convert a cryptomatte hash to a float.
+ * Convert a cryptomatte hash to a float.
*
* Cryptomatte hashes are stored in float textures and images. The conversion is taken from the
* cryptomatte specification. See Floating point conversion section in
diff --git a/source/blender/blenkernel/BKE_fcurve.h b/source/blender/blenkernel/BKE_fcurve.h
index cdee166251c..382bfd5b7db 100644
--- a/source/blender/blenkernel/BKE_fcurve.h
+++ b/source/blender/blenkernel/BKE_fcurve.h
@@ -43,16 +43,16 @@ typedef struct CfraElem {
/* ************** F-Curve Modifiers *************** */
-/* F-Curve Modifier Type-Info (fmi):
- * This struct provides function pointers for runtime, so that functions can be
- * written more generally (with fewer/no special exceptions for various modifiers).
+/**
+ * F-Curve Modifier Type-Info (fmi):
+ * This struct provides function pointers for runtime, so that functions can be
+ * written more generally (with fewer/no special exceptions for various modifiers).
*
- * Callers of these functions must check that they actually point to something useful,
- * as some constraints don't define some of these.
+ * Callers of these functions must check that they actually point to something useful,
+ * as some constraints don't define some of these.
*
- * Warning: it is not too advisable to reorder order of members of this struct,
- * as you'll have to edit quite a few ($FMODIFIER_NUM_TYPES) of these
- * structs.
+ * \warning it is not too advisable to reorder order of members of this struct,
+ * as you'll have to edit quite a few (#FMODIFIER_NUM_TYPES) of these structs.
*/
typedef struct FModifierTypeInfo {
/* admin/ident */
diff --git a/source/blender/blenkernel/BKE_gpencil_update_cache.h b/source/blender/blenkernel/BKE_gpencil_update_cache.h
index f6ae7b53005..32d971ffdb9 100644
--- a/source/blender/blenkernel/BKE_gpencil_update_cache.h
+++ b/source/blender/blenkernel/BKE_gpencil_update_cache.h
@@ -31,16 +31,17 @@ typedef enum eGPUpdateCacheNodeFlag {
} eGPUpdateCacheNodeFlag;
/**
- * Cache for what needs to be updated after bGPdata was modified.
+ * Cache for what needs to be updated after bGPdata was modified.
*
- * Every node holds information about one element that was changed:
- * - the index of where that element is in the linked-list
- * - the pointer to the original element in bGPdata
- * Additionally, nodes also hold other nodes that are one "level" below them.
- * E.g. a node that represents a change on a bGPDframe could contain a set of
- * nodes that represent a change on bGPDstrokes.
- * These nodes are stored in a red-black tree so that they are sorted by their
- * index to make sure they can be processed in the correct order.
+ * Every node holds information about one element that was changed:
+ * - The index of where that element is in the linked-list.
+ * - The pointer to the original element in bGPdata.
+ *
+ * Additionally, nodes also hold other nodes that are one "level" below them.
+ * E.g. a node that represents a change on a bGPDframe could contain a set of
+ * nodes that represent a change on bGPDstrokes.
+ * These nodes are stored in a red-black tree so that they are sorted by their
+ * index to make sure they can be processed in the correct order.
*/
typedef struct GPencilUpdateCache {
/* Mapping from index to a GPencilUpdateCache struct. */
diff --git a/source/blender/blenkernel/BKE_node.h b/source/blender/blenkernel/BKE_node.h
index 23f14f9be9d..c9228db9ecc 100644
--- a/source/blender/blenkernel/BKE_node.h
+++ b/source/blender/blenkernel/BKE_node.h
@@ -773,9 +773,9 @@ struct bNode *nodeGetActiveTexture(struct bNodeTree *ntree);
struct bNode *nodeGetActivePaintCanvas(struct bNodeTree *ntree);
/**
- * @brief Does the given node supports the sub active flag.
+ * \brief Does the given node supports the sub active flag.
*
- * @param sub_active The active flag to check. NODE_ACTIVE_TEXTURE/NODE_ACTIVE_PAINT_CANVAS
+ * \param sub_active: The active flag to check. #NODE_ACTIVE_TEXTURE / #NODE_ACTIVE_PAINT_CANVAS.
*/
bool nodeSupportsActiveFlag(const struct bNode *node, int sub_active);
diff --git a/source/blender/blenkernel/BKE_rigidbody.h b/source/blender/blenkernel/BKE_rigidbody.h
index 83c0f5639c4..9c4bb01c22a 100644
--- a/source/blender/blenkernel/BKE_rigidbody.h
+++ b/source/blender/blenkernel/BKE_rigidbody.h
@@ -124,7 +124,7 @@ void BKE_rigidbody_validate_sim_world(struct Scene *scene,
/**
* Helper function to calculate volume of rigid-body object.
-
+ *
* TODO: allow a parameter to specify method used to calculate this?
*/
void BKE_rigidbody_calc_volume(struct Object *ob, float *r_vol);
diff --git a/source/blender/blenkernel/intern/constraint.c b/source/blender/blenkernel/intern/constraint.c
index 0bab3d826fd..e85524d4bcb 100644
--- a/source/blender/blenkernel/intern/constraint.c
+++ b/source/blender/blenkernel/intern/constraint.c
@@ -888,7 +888,7 @@ static void default_get_tarmat_full_bbone(struct Depsgraph *UNUSED(depsgraph),
/* This following macro should be used for all standard single-target *_get_tars functions
* to save typing and reduce maintenance woes. It does not do the subtarget related operations
* (Hopefully all compilers will be happy with the lines with just a space on them. Those are
- * really just to help this code easier to read)
+ * really just to help this code easier to read)
*/
/* TODO: cope with getting rotation order... */
#define SINGLETARGETNS_GET_TARS(con, datatar, ct, list) \
@@ -932,7 +932,7 @@ static void default_get_tarmat_full_bbone(struct Depsgraph *UNUSED(depsgraph),
* to save typing and reduce maintenance woes. It does not do the subtarget related operations.
* NOTE: the pointer to ct will be changed to point to the next in the list (as it gets removed)
* (Hopefully all compilers will be happy with the lines with just a space on them. Those are
- * really just to help this code easier to read)
+ * really just to help this code easier to read)
*/
#define SINGLETARGETNS_FLUSH_TARS(con, datatar, ct, list, no_copy) \
{ \
diff --git a/source/blender/blenkernel/intern/type_conversions.cc b/source/blender/blenkernel/intern/type_conversions.cc
index aa79199d668..e84ec5b3890 100644
--- a/source/blender/blenkernel/intern/type_conversions.cc
+++ b/source/blender/blenkernel/intern/type_conversions.cc
@@ -21,7 +21,7 @@ static void add_implicit_conversion(DataTypeConversions &conversions)
static fn::CustomMF_SI_SO<From, To> multi_function{
conversion_name.c_str(),
/* Use lambda instead of passing #ConversionF directly, because otherwise the compiler won't
- inline the function. */
+ * inline the function. */
[](const From &a) { return ConversionF(a); }};
static auto convert_single_to_initialized = [](const void *src, void *dst) {
*(To *)dst = ConversionF(*(const From *)src);
diff --git a/source/blender/blenlib/BLI_delaunay_2d.h b/source/blender/blenlib/BLI_delaunay_2d.h
index 2d8428e164f..53c2ff1c345 100644
--- a/source/blender/blenlib/BLI_delaunay_2d.h
+++ b/source/blender/blenlib/BLI_delaunay_2d.h
@@ -5,8 +5,8 @@
/** \file
* \ingroup bli
*
- * This header file contains both a C interface and a C++ interface
- * to the 2D Constrained Delaunay Triangulation library routine.
+ * This header file contains both a C interface and a C++ interface
+ * to the 2D Constrained Delaunay Triangulation library routine.
*/
#ifdef __cplusplus
diff --git a/source/blender/blenlib/BLI_fileops.h b/source/blender/blenlib/BLI_fileops.h
index 04b40904187..3ce2b90e729 100644
--- a/source/blender/blenlib/BLI_fileops.h
+++ b/source/blender/blenlib/BLI_fileops.h
@@ -270,7 +270,7 @@ struct LinkNode *BLI_file_read_as_lines(const char *file) ATTR_WARN_UNUSED_RESUL
void *BLI_file_read_text_as_mem(const char *filepath, size_t pad_bytes, size_t *r_size);
/**
* Return the text file data with:
-
+ *
* - Newlines replaced with '\0'.
* - Optionally trim white-space, replacing trailing <space> & <tab> with '\0'.
*
diff --git a/source/blender/blenlib/BLI_mesh_intersect.hh b/source/blender/blenlib/BLI_mesh_intersect.hh
index ba1d9b293c7..22ea83760aa 100644
--- a/source/blender/blenlib/BLI_mesh_intersect.hh
+++ b/source/blender/blenlib/BLI_mesh_intersect.hh
@@ -5,8 +5,8 @@
/** \file
* \ingroup bli
*
- * Mesh intersection library functions.
- * Uses exact arithmetic, so need GMP.
+ * Mesh intersection library functions.
+ * Uses exact arithmetic, so need GMP.
*/
#ifdef WITH_GMP
diff --git a/source/blender/blenlib/BLI_string.h b/source/blender/blenlib/BLI_string.h
index 7d0884f83dc..45abac33795 100644
--- a/source/blender/blenlib/BLI_string.h
+++ b/source/blender/blenlib/BLI_string.h
@@ -255,7 +255,7 @@ size_t BLI_str_unescape(char *__restrict dst, const char *__restrict src, size_t
*
* \param str: Typ
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list