Cleanup: move public doc-strings into headers for 'blenkernel'

- Added space below non doc-string comments to make it clear
  these aren't comments for the symbols directly below them.
- Use doxy sections for some headers.
- Minor improvements to doc-strings.

Ref T92709

1 files changed, 18 insertions, 2 deletions

diff --git a/source/blender/blenkernel/BKE_collision.h b/source/blender/blenkernel/BKE_collision.h
index 2c21b7355d6..71929d1797c 100644
--- a/source/blender/blenkernel/BKE_collision.h
+++ b/source/blender/blenkernel/BKE_collision.h
@@ -116,8 +116,11 @@ void bvhtree_update_from_mvert(struct BVHTree *bvhtree,
 
 /////////////////////////////////////////////////
 
-/* move Collision modifier object inter-frame with step = [0,1]
- * defined in collisions.c */
+/**
+ * Move Collision modifier object inter-frame with step = [0,1]
+ *
+ * \param step: is limited from 0 (frame start position) to 1 (frame end position).
+ */
 void collision_move_object(struct CollisionModifierData *collmd,
                            const float step,
                            const float prevstep,
@@ -135,6 +138,11 @@ typedef struct CollisionRelation {
   struct Object *ob;
 } CollisionRelation;
 
+/**
+ * Create list of collision relations in the collection or entire scene.
+ * This is used by the depsgraph to build relations, as well as faster
+ * lookup of colliders during evaluation.
+ */
 struct ListBase *BKE_collision_relations_create(struct Depsgraph *depsgraph,
                                                 struct Collection *collection,
                                                 unsigned int modifier_type);
@@ -142,6 +150,10 @@ void BKE_collision_relations_free(struct ListBase *relations);
 
 /* Collision object lists for physics simulation evaluation. */
 
+/**
+ * Create effective list of colliders from relations built beforehand.
+ * Self will be excluded.
+ */
 struct Object **BKE_collision_objects_create(struct Depsgraph *depsgraph,
                                              struct Object *self,
                                              struct Collection *collection,
@@ -155,6 +167,10 @@ typedef struct ColliderCache {
   struct CollisionModifierData *collmd;
 } ColliderCache;
 
+/**
+ * Create effective list of colliders from relations built beforehand.
+ * Self will be excluded.
+ */
 struct ListBase *BKE_collider_cache_create(struct Depsgraph *depsgraph,
                                            struct Object *self,
                                            struct Collection *collection);