changeset 196:658ee50b8bcb

doc: improve doxygen documentation
author David Demelier <markand@malikania.fr>
date Mon, 09 Nov 2020 10:36:39 +0100
parents 02285657294c
children 852d0b7817ce
files librpg/rpg/battle-bar.h
diffstat 1 files changed, 8 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/librpg/rpg/battle-bar.h	Sat Nov 07 21:08:47 2020 +0100
+++ b/librpg/rpg/battle-bar.h	Mon Nov 09 10:36:39 2020 +0100
@@ -149,6 +149,12 @@
 void
 battle_bar_reset(struct battle_bar *bar);
 
+/**
+ * Open global menu.
+ *
+ * \pre bar != NULL
+ * \param bar the bar
+ */
 void
 battle_bar_open_menu(struct battle_bar *bar);
 
@@ -156,8 +162,10 @@
  * Open the view to select a spell by opening the grid menu.
  *
  * \pre bar != NULL
+ * \pre bt != NULL
  * \pre character_ok(ch)
  * \param bar this bar
+ * \param bt the current battle
  * \param ch the owner of spells
  */
 void