[Bf-blender-cvs] [6db1fb197c1] master: Cleanup: spelling, doxygen comment formatting
Campbell Barton
noreply at git.blender.org
Sun Mar 21 04:16:24 CET 2021
Commit: 6db1fb197c169633bef9b23542464f89e9c4dbe6
Author: Campbell Barton
Date: Sun Mar 21 13:18:20 2021 +1100
Branches: master
https://developer.blender.org/rB6db1fb197c169633bef9b23542464f89e9c4dbe6
Cleanup: spelling, doxygen comment formatting
===================================================================
M intern/cycles/render/alembic.h
M intern/ghost/intern/GHOST_DropTargetWin32.cpp
M source/blender/blenkernel/intern/blender_undo.c
M source/blender/blenkernel/intern/lib_override.c
M source/blender/blenkernel/intern/object_update.c
M source/blender/blenlib/BLI_delaunay_2d.h
M source/blender/bmesh/operators/bmo_inset.c
M source/blender/compositor/intern/COM_Debug.h
M source/blender/draw/engines/eevee/eevee_bloom.c
M source/blender/draw/engines/eevee/eevee_occlusion.c
M source/blender/editors/space_spreadsheet/spreadsheet_column_layout.hh
M source/blender/editors/transform/transform.h
M source/blender/gpencil_modifiers/intern/MOD_gpencillineart.c
M source/blender/gpencil_modifiers/intern/lineart/MOD_lineart.h
M source/blender/gpencil_modifiers/intern/lineart/lineart_chain.c
M source/blender/gpencil_modifiers/intern/lineart/lineart_cpu.c
M source/blender/gpencil_modifiers/intern/lineart/lineart_ops.c
M source/blender/imbuf/IMB_imbuf_types.h
M source/blender/imbuf/intern/indexer.c
M source/blender/makesdna/DNA_gpencil_modifier_types.h
M source/blender/makesdna/DNA_lineart_types.h
M source/blender/makesdna/DNA_node_types.h
M source/blender/makesdna/DNA_userdef_types.h
M source/blender/makesrna/intern/rna_sequencer_api.c
M source/blender/nodes/NOD_node_tree_ref.hh
===================================================================
diff --git a/intern/cycles/render/alembic.h b/intern/cycles/render/alembic.h
index 0fc02f1da23..0203475571e 100644
--- a/intern/cycles/render/alembic.h
+++ b/intern/cycles/render/alembic.h
@@ -43,14 +43,14 @@ struct MatrixSamplesData {
Alembic::AbcCoreAbstract::TimeSamplingPtr time_sampling;
};
-/* Helpers to detect if some type is a ccl::array. */
+/* Helpers to detect if some type is a `ccl::array`. */
template<typename> struct is_array : public std::false_type {
};
template<typename T> struct is_array<array<T>> : public std::true_type {
};
-/* Holds the data for a cache lookup at a given time, as well as informations to
+/* Holds the data for a cache lookup at a given time, as well as information to
* help disambiguate successes or failures to get data from the cache. */
template<typename T> class CacheLookupResult {
enum class State {
diff --git a/intern/ghost/intern/GHOST_DropTargetWin32.cpp b/intern/ghost/intern/GHOST_DropTargetWin32.cpp
index fe11d9a28f2..ab4b48da9b4 100644
--- a/intern/ghost/intern/GHOST_DropTargetWin32.cpp
+++ b/intern/ghost/intern/GHOST_DropTargetWin32.cpp
@@ -178,8 +178,8 @@ DWORD GHOST_DropTargetWin32::allowedDropEffect(DWORD dwAllowed)
GHOST_TDragnDropTypes GHOST_DropTargetWin32::getGhostType(IDataObject *pDataObject)
{
/* Text
- * Note: Unicode text is available as CF_TEXT too, the system can do the
- * conversion, but we do the conversion ourself with WC_NO_BEST_FIT_CHARS.
+ * NOTE: Unicode text is available as CF_TEXT too, the system can do the
+ * conversion, but we do the conversion our self with #WC_NO_BEST_FIT_CHARS.
*/
FORMATETC fmtetc = {CF_TEXT, 0, DVASPECT_CONTENT, -1, TYMED_HGLOBAL};
if (pDataObject->QueryGetData(&fmtetc) == S_OK) {
diff --git a/source/blender/blenkernel/intern/blender_undo.c b/source/blender/blenkernel/intern/blender_undo.c
index 293b2c9c4c6..02076823675 100644
--- a/source/blender/blenkernel/intern/blender_undo.c
+++ b/source/blender/blenkernel/intern/blender_undo.c
@@ -115,7 +115,7 @@ MemFileUndoData *BKE_memfile_undo_encode(Main *bmain, MemFileUndoData *mfu_prev)
{
MemFileUndoData *mfu = MEM_callocN(sizeof(MemFileUndoData), __func__);
- /* Include recovery infomation since undo-data is written out as #BLENDER_QUIT_FILE. */
+ /* Include recovery information since undo-data is written out as #BLENDER_QUIT_FILE. */
const int fileflags = G.fileflags | G_FILE_RECOVER_WRITE;
/* disk save version */
diff --git a/source/blender/blenkernel/intern/lib_override.c b/source/blender/blenkernel/intern/lib_override.c
index 38c115c07a1..48a5d47fff6 100644
--- a/source/blender/blenkernel/intern/lib_override.c
+++ b/source/blender/blenkernel/intern/lib_override.c
@@ -650,10 +650,10 @@ BLI_INLINE bool lib_override_library_create_post_process_object_is_instantiated(
ViewLayer *view_layer, Object *object, const bool is_resync)
{
/* We cannot rely on check for object being actually instantiated in resync case, because often
- * the overridden collection is 'excluded' from the current viewlayer.
+ * the overridden collection is 'excluded' from the current view-layer.
*
- * Fallback to a basic usercount check then, this is weak (since it could lead to some object not
- * being instantiated at all), but it should work fine in most common cases. */
+ * Fallback to a basic user-count check then, this is weak (since it could lead to some object
+ * not being instantiated at all), but it should work fine in most common cases. */
return ((is_resync && ID_REAL_USERS(object) >= 1) ||
(!is_resync && BKE_view_layer_base_find(view_layer, object) != NULL));
}
diff --git a/source/blender/blenkernel/intern/object_update.c b/source/blender/blenkernel/intern/object_update.c
index 1e6a099040f..b1ae4abd9bb 100644
--- a/source/blender/blenkernel/intern/object_update.c
+++ b/source/blender/blenkernel/intern/object_update.c
@@ -176,8 +176,8 @@ void BKE_object_handle_data_update(Depsgraph *depsgraph, Scene *scene, Object *o
CustomData_MeshMasks cddata_masks = scene->customdata_mask;
CustomData_MeshMasks_update(&cddata_masks, &CD_MASK_BAREMESH);
- /* Make sure Freestyle edge/face marks appear in DM for render (see T40315). Due to Line Art
- * impementation, edge marks should also be shown in viewport. */
+ /* Make sure Freestyle edge/face marks appear in DM for render (see T40315).
+ * Due to Line Art implementation, edge marks should also be shown in viewport. */
#ifdef WITH_FREESTYLE
cddata_masks.emask |= CD_MASK_FREESTYLE_EDGE;
cddata_masks.pmask |= CD_MASK_FREESTYLE_FACE;
diff --git a/source/blender/blenlib/BLI_delaunay_2d.h b/source/blender/blenlib/BLI_delaunay_2d.h
index 7027477ac7f..e91726991ca 100644
--- a/source/blender/blenlib/BLI_delaunay_2d.h
+++ b/source/blender/blenlib/BLI_delaunay_2d.h
@@ -178,7 +178,7 @@ typedef enum CDT_output_type {
CDT_FULL,
/** All triangles fully enclosed by constraint edges or faces. */
CDT_INSIDE,
- /** Only point, edge, and face constraints, and their intersections. */
+ /** Only point, edge, and face constraints, and their intersections. */
CDT_CONSTRAINTS,
/**
* Like CDT_CONSTRAINTS, but keep enough
diff --git a/source/blender/bmesh/operators/bmo_inset.c b/source/blender/bmesh/operators/bmo_inset.c
index 3869a0678e2..9e8e330e87c 100644
--- a/source/blender/bmesh/operators/bmo_inset.c
+++ b/source/blender/bmesh/operators/bmo_inset.c
@@ -531,7 +531,7 @@ static float bm_edge_info_average_length(BMVert *v, SplitEdgeInfo *edge_info)
return -1.0f;
}
-/**.
+/**
* Fill in any vertices that are in the inset region but not connected to an edge being inset.
*
*
diff --git a/source/blender/compositor/intern/COM_Debug.h b/source/blender/compositor/intern/COM_Debug.h
index 35e44506ef2..0107d8b396d 100644
--- a/source/blender/compositor/intern/COM_Debug.h
+++ b/source/blender/compositor/intern/COM_Debug.h
@@ -69,10 +69,15 @@ class DebugInfo {
private:
static int m_file_index;
- static NodeNameMap m_node_names; /**< map nodes to usable names for debug output */
- static OpNameMap m_op_names; /**< map operations to usable names for debug output */
- static std::string m_current_node_name; /**< base name for all operations added by a node */
- static std::string m_current_op_name; /**< base name for automatic sub-operations */
- static GroupStateMap m_group_states; /**< for visualizing group states */
+ /** Map nodes to usable names for debug output. */
+ static NodeNameMap m_node_names;
+ /** Map operations to usable names for debug output. */
+ static OpNameMap m_op_names;
+ /** Base name for all operations added by a node. */
+ static std::string m_current_node_name;
+ /** Base name for automatic sub-operations. */
+ static std::string m_current_op_name;
+ /** For visualizing group states. */
+ static GroupStateMap m_group_states;
#endif
};
diff --git a/source/blender/draw/engines/eevee/eevee_bloom.c b/source/blender/draw/engines/eevee/eevee_bloom.c
index 9b8f7ddab0c..cc6e75859c8 100644
--- a/source/blender/draw/engines/eevee/eevee_bloom.c
+++ b/source/blender/draw/engines/eevee/eevee_bloom.c
@@ -171,7 +171,8 @@ void EEVEE_bloom_cache_init(EEVEE_ViewLayerData *UNUSED(sldata), EEVEE_Data *ved
psl->bloom_accum_ps = NULL;
if ((effects->enabled_effects & EFFECT_BLOOM) != 0) {
- /** Bloom algorithm
+ /**
+ * Bloom Algorithm
*
* Overview:
* - Down-sample the color buffer doing a small blur during each step.
diff --git a/source/blender/draw/engines/eevee/eevee_occlusion.c b/source/blender/draw/engines/eevee/eevee_occlusion.c
index 8f8317498ec..3f198063c47 100644
--- a/source/blender/draw/engines/eevee/eevee_occlusion.c
+++ b/source/blender/draw/engines/eevee/eevee_occlusion.c
@@ -158,9 +158,10 @@ void EEVEE_occlusion_cache_init(EEVEE_ViewLayerData *sldata, EEVEE_Data *vedata)
DefaultTextureList *dtxl = DRW_viewport_texture_list_get();
if ((effects->enabled_effects & EFFECT_GTAO) != 0) {
- /** Occlusion algorithm overview
+ /**
+ * Occlusion Algorithm Overview:
*
- * We separate the computation into 2 steps.
+ * We separate the computation into 2 steps.
*
* - First we scan the neighborhood pixels to find the maximum horizon angle.
* We save this angle in a RG8 array texture.
diff --git a/source/blender/editors/space_spreadsheet/spreadsheet_column_layout.hh b/source/blender/editors/space_spreadsheet/spreadsheet_column_layout.hh
index a01e251d764..cfbf6963a9d 100644
--- a/source/blender/editors/space_spreadsheet/spreadsheet_column_layout.hh
+++ b/source/blender/editors/space_spreadsheet/spreadsheet_column_layout.hh
@@ -40,7 +40,7 @@ struct CollectionCellValue {
class CellValue {
public:
/* The implementation just uses a `std::variant` for simplicity. It can be encapsulated better,
- * but it's not really worth the complixity for now. */
+ * but it's not really worth the complexity for now. */
using VariantType =
std::variant<std::monostate, int, float, bool, ObjectCellValue, CollectionCellValue>;
diff --git a/source/blender/editors/transform/transform.h b/source/blender/editors/transform/transform.h
index 4b43592165b..f2d5800abb7 100644
--- a/source/blender/editors/transform/transform.h
+++ b/source/blender/editors/transform/transform.h
@@ -487,7 +487,7 @@ typedef struct TransDataContainer {
*/
bool use_local_mat;
- /** Mirror option. */
+ /** Mirror option. */
union {
struct {
uint use_mirror_axis_x : 1;
diff --git a/source/blender/gpencil_modifiers/intern/MOD_gpencillineart.c b/source/blender/gpencil_modifiers/intern/MOD_gpencillineart.c
index a7cd8ffb31b..53b6dc98bc1 100644
--- a/source/blender/gpencil_modifiers/intern/MOD_gpencillineart.c
+++ b/source/blender/gpencil_modifiers/intern/MOD_gpencillineart.c
@@ -141,9 +141,9 @@ static void generateStrokes(GpencilModifierData *md, Depsgraph *depsgraph, Objec
LineartGpencilModifierData *lmd = (LineartGpencilModifierData *)md;
bGPdata *gpd = ob->data;
- /* Guard early, don't trigger calculation when no gpencil frame is present. Probably should
- * disable in the isModifierDisabled() funct
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list