diff libmlk-core/mlk/core/action-stack.h @ 518:47f0fe6f6581

core: doxygenize drawable-stack
author David Demelier <markand@malikania.fr>
date Sat, 04 Mar 2023 14:42:03 +0100
parents 6e8f6640e05b
children 75944708c55c
line wrap: on
line diff
--- a/libmlk-core/mlk/core/action-stack.h	Sat Mar 04 14:23:59 2023 +0100
+++ b/libmlk-core/mlk/core/action-stack.h	Sat Mar 04 14:42:03 2023 +0100
@@ -53,7 +53,7 @@
 	/**
 	 * (read-write)
 	 *
-	 * Number of actions in array ::mlk_action_script::actions
+	 * Number of actions in array ::mlk_action_stack::actions
 	 *
 	 * \warning changing this value must be kept in sync with the array
 	 *          dimension.
@@ -66,7 +66,7 @@
 #endif
 
 /**
- * Initialize the action sequence structure.
+ * Initialize the action stack structure.
  *
  * This function will set all pointers in the ::mlk_action_stack::actions to
  * NULL.
@@ -129,6 +129,7 @@
  * \pre stack != NULL
  * \param stack the action stack
  * \param ticks frame ticks
+ * \return non-zero if completed
  */
 int
 mlk_action_stack_update(struct mlk_action_stack *stack,
@@ -144,6 +145,7 @@
 mlk_action_stack_draw(const struct mlk_action_stack *stack);
 
 /**
+ * Invoke ::mlk_action_finish on all actions left.
  *
  * \pre stack != NULL
  * \param stack the action stack