diff libcore/core/drawable.h @ 147:b386d25832c8

doc: use new nomenclature, closes #2497
author David Demelier <markand@malikania.fr>
date Thu, 15 Oct 2020 09:21:04 +0200
parents fea0cc899931
children eb0a7ab71023
line wrap: on
line diff
--- a/libcore/core/drawable.h	Wed Oct 14 18:20:58 2020 +0200
+++ b/libcore/core/drawable.h	Thu Oct 15 09:21:04 2020 +0200
@@ -37,12 +37,12 @@
  * This structure is used to
  */
 struct drawable {
-	void *data;     /*!< (RW) Drawable data. */
-	int x;          /*!< (RW) X coordinate if necessary. */
-	int y;          /*!< (RW) Y coordinate if necessary. */
+	void *data;     /*!< (+&?) Drawable data. */
+	int x;          /*!< (+) X coordinate if necessary. */
+	int y;          /*!< (+) Y coordinate if necessary. */
 
 	/**
-	 * Update this drawable.
+	 * (+?) Update this drawable.
 	 *
 	 * \param dw the drawable object
 	 * \param ticks the number of ticks since last frame
@@ -51,23 +51,21 @@
 	bool (*update)(struct drawable *dw, unsigned int ticks);
 
 	/**
-	 * Draw this drawable.
+	 * (+?) Draw this drawable.
 	 *
 	 * \param dw the drawable object
 	 */
 	void (*draw)(struct drawable *dw);
 
 	/**
-	 * (RW)
-	 *
-	 * Called immediately after the drawable ended.
+	 * (+?) Called when drawable finished.
 	 *
 	 * \param act this action
 	 */
 	void (*end)(struct drawable *act);
 	
 	/**
-	 * Destroy the drawable if necessary.
+	 * (+?) Destroy the drawable if necessary.
 	 *
 	 * \note This function is optional and can be NULL.
 	 * \param dw the drawable object
@@ -122,7 +120,7 @@
  * You can add, clear, update and draw them.
  */
 struct drawable_stack {
-	struct drawable *objects[DRAWABLE_STACK_MAX];   /*!< (RW) Drawables. */
+	struct drawable *objects[DRAWABLE_STACK_MAX];   /*!< (+&?) Drawables. */
 };
 
 /**