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.

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).
  *

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,

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

source/blender/blenkernel/BKE_fcurve.h

@@ -43,16 +43,16 @@ typedef struct CfraElem {
 
 /* ************** F-Curve Modifiers *************** */
 
-/* F-Curve Modifier Type-Info (fmi):
+/**
+ * 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.
  *
- *  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 */

source/blender/blenkernel/BKE_gpencil_update_cache.h

@@ -34,8 +34,9 @@ typedef enum eGPUpdateCacheNodeFlag {
  * 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
+ * - 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.

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

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

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

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'.
  *

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: Typically this is the first character in a quoted string.
  * Where the character before `*str` would be `"`.
-
+ *
  * \return The pointer to the first un-escaped quote.
  */
 const char *BLI_str_escape_find_quote(const char *str) ATTR_NONNULL();

source/blender/blenlib/intern/delaunay_2d.cc

@@ -2807,7 +2807,7 @@ blender::meshintersect::CDT_result<mpq_class> delaunay_2d_calc(const CDT_input<m
 /* C interface. */
 
 /**
-   This function uses the double version of #CDT::delaunay_calc.
+ * This function uses the double version of #CDT::delaunay_calc.
  * Almost all of the work here is to convert between C++ #Arrays<Vector<int>>
  * and a C version that linearizes all the elements and uses a "start"
  * and "len" array to say where the individual vectors start and how

source/blender/depsgraph/intern/eval/deg_eval_copy_on_write.cc

@@ -988,7 +988,7 @@ void discard_edit_mode_pointers(ID *id_cow)
 }  // namespace
 
 /**
-   Free content of the CoW data-block.
+ *  Free content of the CoW data-block.
  * Notes:
  * - Does not recurse into nested ID data-blocks.
  * - Does not free data-block itself.

source/blender/draw/engines/image/image_space.hh

@@ -13,7 +13,7 @@ struct ShaderParameters;
  * Space accessor.
  *
  * Image engine is used to draw the images inside multiple spaces \see SpaceLink.
- *  The AbstractSpaceAccessor is an interface to communicate with a space.
+ * The #AbstractSpaceAccessor is an interface to communicate with a space.
  */
 class AbstractSpaceAccessor {
  public:

source/blender/draw/engines/workbench/shaders/infos/workbench_prepass_info.hh

@@ -92,7 +92,7 @@ GPU_SHADER_CREATE_INFO(workbench_material)
 
 GPU_SHADER_CREATE_INFO(workbench_transparent_accum)
     /* Note: Blending will be skipped on objectId because output is a
-       non-normalized integer buffer. */
+     * non-normalized integer buffer. */
     .fragment_out(0, Type::VEC4, "transparentAccum")
     .fragment_out(1, Type::VEC4, "revealageAccum")
     .fragment_out(2, Type::UINT, "objectId")

source/blender/editors/armature/pose_slide.c

@@ -8,20 +8,20 @@
  * ====================
  *
  * - Push & Relax, Breakdowner
-
+ *
  *   These tools provide the animator with various capabilities
  *   for interactively controlling the spacing of poses, but also
  *   for 'pushing' and/or 'relaxing' extremes as they see fit.
  *
  * - Propagate
-
+ *
  *   This tool copies elements of the selected pose to successive
  *   keyframes, allowing the animator to go back and modify the poses
  *   for some "static" pose controls, without having to repeatedly
  *   doing a "next paste" dance.
  *
  * - Pose Sculpting (TODO)
-
+ *
  *   This is yet to be implemented, but the idea here is to use
  *   sculpting techniques to make it easier to pose rigs by allowing
  *   rigs to be manipulated using a familiar paint-based interface.

source/blender/editors/render/render_shading.cc

@@ -1281,7 +1281,7 @@ void SCENE_OT_view_layer_add_used_lightgroups(wmOperatorType *ot)
 /** \} */
 
 /* -------------------------------------------------------------------- */
-/** \name View Layer Remove Unussed Lightgroups Operator
+/** \name View Layer Remove Unused Lightgroups Operator
  * \{ */
 
 static int view_layer_remove_unused_lightgroups_exec(bContext *C, wmOperator *UNUSED(op))

source/blender/editors/sculpt_paint/sculpt_intern.h

@@ -201,13 +201,11 @@ struct SculptRakeData {
   float follow_co[3];
 };
 
-/*
-Generic thread data.  The size of this struct
-has gotten a little out of hand; normally we would
-split it up, but it might be better to see if we can't
-eliminate it altogether after moving to C++ (where
-we'll be able to use lambdas).
-*/
+/**
+ * Generic thread data. The size of this struct has gotten a little out of hand;
+ * normally we would split it up, but it might be better to see if we can't eliminate it
+ * altogether after moving to C++ (where we'll be able to use lambdas).
+ */
 typedef struct SculptThreadedTaskData {
   struct bContext *C;
   struct Sculpt *sd;

source/blender/editors/sculpt_paint/sculpt_paint_color.c

@@ -454,7 +454,7 @@ static void do_smear_brush_task_cb_exec(void *__restrict userdata,
         }
 
         /* Multiply weight with edge lengths (in the future this will be
-           cotangent weights or face areas). */
+         * cotangent weights or face areas). */
         w *= len;
 
         /* Build directional weight. */

source/blender/freestyle/intern/view_map/Interface1D.h

@@ -27,31 +27,46 @@ using namespace std;
 namespace Freestyle {
 
 // Integration method
-/** The different integration methods that can be invoked to integrate into a single value the set
+/**
+ * The different integration methods that can be invoked to integrate into a single value the set
  * of values obtained from each 0D element of a 1D element.
  */
 typedef enum {
-  MEAN, /**< The value computed for the 1D element is the mean of the values obtained for the 0D
-           elements. */
-  MIN,  /**< The value computed for the 1D element is the minimum of the values obtained for the 0D
-           elements. */
-  MAX,  /**< The value computed for the 1D element is the maximum of the values obtained for the 0D
-           elements. */
-  FIRST, /**< The value computed for the 1D element is the first of the values obtained for the 0D
-            elements. */
-  LAST,  /**< The value computed for the 1D element is the last of the values obtained for the 0D
-            elements. */
+  /**
+   * The value computed for the 1D element is the mean of the values obtained for the 0D elements.
+   */
+  MEAN,
+  /**
+   * The value computed for the 1D element is the minimum of the values obtained for the 0D
+   * elements.
+   */
+  MIN,
+  /**
+   * The value computed for the 1D element is the maximum of the values obtained for the 0D
+   * elements.
+   */
+  MAX,
+  /**
+   * The value computed for the 1D element is the first of the values obtained for the 0D
+   *  elements.
+   */
+  FIRST,
+  /**
+   * The value computed for the 1D element is the last of the values obtained for the 0D
+   * elements.
+   */
+  LAST,
 } IntegrationType;
 
-/** Returns a single value from a set of values evaluated at each 0D element of this 1D element.
- * \param fun:
- *    The UnaryFunction0D used to compute a value at each Interface0D.
- * \param it:
- *    The Interface0DIterator used to iterate over the 0D elements of this 1D element. The
- * integration will occur over the 0D elements starting from the one pointed by it. \param it_end:
- *    The Interface0DIterator pointing the end of the 0D elements of the 1D element.
- * \param integration_type:
- *    The integration method used to compute a single value from a set of values.
+/**
+ * Returns a single value from a set of values evaluated at each 0D element of this 1D element.
+ *
+ * \param fun: The UnaryFunction0D used to compute a value at each Interface0D.
+ * \param it: The Interface0DIterator used to iterate over the 0D elements of this 1D element.
+ * The integration will occur over the 0D elements starting from the one pointed by it.
+ * \param it_end: The Interface0DIterator pointing the end of the 0D elements of the 1D element.
+ * \param integration_type: The integration method used to compute a single value from a set of
+ * values.
  * \return the single value obtained for the 1D element.
  */
 template<class T>

source/blender/functions/FN_multi_function_builder.hh

@@ -20,7 +20,7 @@ namespace blender::fn {
  * 2. single output (SO) of type Out1
  *
  * This example creates a function that adds 10 to the incoming values:
- *  CustomMF_SI_SO<int, int> fn("add 10", [](int value) { return value + 10; });
+ * `CustomMF_SI_SO<int, int> fn("add 10", [](int value) { return value + 10; });`
  */
 template<typename In1, typename Out1> class CustomMF_SI_SO : public MultiFunction {
  private:

source/blender/gpencil_modifiers/intern/MOD_gpencilenvelope.c

@@ -218,10 +218,12 @@ static void apply_stroke_envelope(
                                  max_ii(0, i + j - spread_left);
       const int i2 = is_cyclic ? (i + j + spread_right) % gps->totpoints :
                                  min_ii(gps->totpoints - 1, i + j + spread_right);
-      /*bool side = dot_v3v3(&old_points[i1].x, plane_no) < dot_v3v3(plane_no, &old_points[i2].x);
+#if 0
+      bool side = dot_v3v3(&old_points[i1].x, plane_no) < dot_v3v3(plane_no, &old_points[i2].x);
       if (side) {
         continue;
-      }*/
+      }
+#endif
       float lambda = line_plane_factor_v3(
           &point->x, plane_no, &old_points[i1].x, &old_points[i2].x);
       if (lambda <= 0.0f || lambda >= 1.0f) {

source/blender/io/usd/intern/usd_reader_material.h

@@ -40,7 +40,7 @@ struct NodePlacementContext {
 /* Converts USD materials to Blender representation. */
 
 /**
-   By default, the #USDMaterialReader creates a Blender material with
+ * By default, the #USDMaterialReader creates a Blender material with
  * the same name as the USD material.  If the USD material has a
  * #UsdPreviewSurface source, the Blender material's viewport display
  * color, roughness and metallic properties are set to the corresponding

source/blender/makesdna/DNA_ID.h

@@ -349,8 +349,10 @@ typedef struct ID_Runtime_Remap {
   int status;
   /** During ID remapping the number of skipped use cases that refcount the data-block. */
   int skipped_refcounted;
-  /** During ID remapping the number of direct use cases that could be remapped (e.g. obdata when
-in edit mode). */
+  /**
+   * During ID remapping the number of direct use cases that could be remapped
+   * (e.g. obdata when in edit mode).
+   */
   int skipped_direct;
   /** During ID remapping, the number of indirect use cases that could not be remapped. */
   int skipped_indirect;

source/blender/makesrna/intern/rna_internal_types.h

@@ -30,14 +30,16 @@ typedef struct IDProperty IDProperty;
 
 /* Function Callbacks */
 
-/** Update callback for an RNA property.
+/**
+ * Update callback for an RNA property.
  *
  * \note This is NOT called automatically when writing into the property, it needs to be called
  * manually (through #RNA_property_update or #RNA_property_update_main) when needed.
  *
  * \param bmain: the Main data-base to which `ptr` data belongs.
  * \param active_scene: The current active scene (may be NULL in some cases).
- *  \param ptr: The RNA pointer data to update. */
+ * \param ptr: The RNA pointer data to update.
+ */
 typedef void (*UpdateFunc)(struct Main *bmain, struct Scene *active_scene, struct PointerRNA *ptr);
 typedef void (*ContextPropUpdateFunc)(struct bContext *C,
                                       struct PointerRNA *ptr,

source/blender/nodes/geometry/nodes/node_geo_dual_mesh.cc

@@ -627,7 +627,7 @@ static void calc_dual_mesh(GeometrySet &geometry_set,
   calc_boundaries(mesh_in, vertex_types, edge_types);
   /* Stores the indices of the polygons connected to the vertex. Because the polygons are looped
    * over in order of their indices, the polygon's indices will be sorted in ascending order.
-   (This can change once they are sorted using `sort_vertex_polys`). */
+   * (This can change once they are sorted using `sort_vertex_polys`). */
   Array<Vector<int>> vertex_poly_indices(mesh_in.totvert);
   Array<Array<int>> vertex_shared_edges(mesh_in.totvert);
   Array<Array<int>> vertex_corners(mesh_in.totvert);

source/blender/python/BPY_extern_run.h

@@ -11,7 +11,7 @@
  *   strings more cumbersome as otherwise small expressions become multi-line code-blocks.
  *   Optional (ignored when NULL), otherwise this is a NULL terminated array of module names.
  *
-     Failure to import any modules prevents any further execution.
+ *   Failure to import any modules prevents any further execution.
  *
  * - `err_info` #BPy_RunErrInfo is passed to some functions so errors can be forwarded to the UI.
  *   Option (when NULL errors are printed to the `stdout` and cleared).

source/blender/python/intern/bpy.c

@@ -189,7 +189,7 @@ static PyObject *bpy_flip_name(PyObject *UNUSED(self), PyObject *args, PyObject
   }
 
   /* Worst case we gain one extra byte (besides null-terminator) by changing
-  "Left" to "Right", because only the first appearance of "Left" gets replaced. */
+   * "Left" to "Right", because only the first appearance of "Left" gets replaced. */
   const size_t size = name_src_len + 2;
   char *name_dst = PyMem_MALLOC(size);
   const size_t name_dst_len = BLI_string_flip_side_name(name_dst, name_src, strip_digits, size);

source/blender/sequencer/intern/image_cache.c

@@ -49,10 +49,11 @@
  * Function:
  * All images created during rendering are added to cache, even if the cache is already full.
  * This is because:
- *  - one image may be needed multiple times during rendering.
- *  - keeping the last rendered frame allows us for faster re-render when user edits strip in stack
- *  - we can decide if we keep frame only when it's completely rendered. Otherwise we risk having
- *    "holes" in the cache, which can be annoying
+ * - One image may be needed multiple times during rendering.
+ * - Keeping the last rendered frame allows us for faster re-render when user edits strip in stack.
+ * - We can decide if we keep frame only when it's completely rendered. Otherwise we risk having
+ *   "holes" in the cache, which can be annoying.
+ *
  * If the cache is full all entries for pending frame will have is_temp_cache set.
  *
  * Linking: We use links to reduce number of iterations over entries needed to manage cache.