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.

9 files changed, 27 insertions, 26 deletions

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);