Mercurial > molko
diff src/sprite.h @ 22:5519ad48822e
doc: add Doxygen documentation, closes #2450
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Thu, 09 Jan 2020 20:48:01 +0100 |
| parents | fc71221b7bee |
| children | 607bd90aba63 |
line wrap: on
line diff
--- a/src/sprite.h Thu Jan 09 20:25:16 2020 +0100 +++ b/src/sprite.h Thu Jan 09 20:48:01 2020 +0100 @@ -32,11 +32,11 @@ * \brief Sprite structure. */ struct sprite { - struct texture *texture; /* Texture to access (RO) */ - uint16_t cellw; /* Width per cell (RW) */ - uint16_t cellh; /* Height per cell (RW) */ - uint16_t nrows; /* Number of rows (RW) */ - uint16_t ncols; /* Number of columns (RW) */ + struct texture *texture; /*!< Texture to access (RO) */ + uint16_t cellw; /*!< Width per cell (RW) */ + uint16_t cellh; /*!< Height per cell (RW) */ + uint16_t nrows; /*!< Number of rows (RW) */ + uint16_t ncols; /*!< Number of columns (RW) */ }; /** @@ -68,6 +68,7 @@ * Draw the sprite component from row `r' and column `c'. * * \pre sprite != NULL + * \param sprite the sprite to draw * \param r the row number * \param c the column number * \param x the X destination