From a466cc429d8017eb0ee22237f5683cc75791fe85 Mon Sep 17 00:00:00 2001
From: omniscient <17525998+omnisci3nce@users.noreply.github.com>
Date: Mon, 11 Mar 2024 19:13:53 +1100
Subject: minor docstring changes + fmt

---
 src/transform_hierarchy.h | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

(limited to 'src/transform_hierarchy.h')

diff --git a/src/transform_hierarchy.h b/src/transform_hierarchy.h
index 91b0559..703baa8 100644
--- a/src/transform_hierarchy.h
+++ b/src/transform_hierarchy.h
@@ -36,11 +36,12 @@ void transform_hierarchy_free(transform_hierarchy* tfh);
 
 // --- Main usecase
 
+/** @brief Updates matrices of any invalidated nodes based on the `is_dirty` flag inside `transform` */
 void transform_hierarchy_propagate_transforms(transform_hierarchy* tfh);
 
 // --- Queries
 
-/** Get a pointer to the root node */
+/** @brief Get a pointer to the root node */
 transform_node* transform_hierarchy_root_node(transform_hierarchy* tfh);
 
 // --- Mutations
@@ -57,8 +58,8 @@ void transform_hierarchy_delete_node(transform_node* node);
  * @param ctx_data An optional pointer to data that is be passed on each call to `visit_node`. Can be used to carry additional information or context.
  *
  * @note The main use-cases are:
-            1. traversing the whole tree to update cached 4x4 affine transform matrices
-            2. freeing child nodes after deleting a node in the tree
-            3. debug pretty printing the whole tree
+            1. traversing the whole tree to update cached 4x4 affine transform matrices (pre-order)
+            2. freeing child nodes after deleting a node in the tree (post-order)
+            3. debug pretty printing the whole tree (post-order)
  */
 void transform_hierarchy_dfs(transform_node* start_node, bool (*visit_node)(transform_node* node, void* ctx_data), bool is_pre_order, void* ctx_data);
\ No newline at end of file
-- 
cgit v1.2.3-70-g09d2