summaryrefslogtreecommitdiff
path: root/pool.h
diff options
context:
space:
mode:
authorpeter1138 <peter1138@openttd.org>2006-03-09 20:37:51 +0000
committerpeter1138 <peter1138@openttd.org>2006-03-09 20:37:51 +0000
commitfca58232381453f503ed9d92b40fd65c3c57bdb6 (patch)
tree061684b960a2757bd9c019a34af1bd45b36d85b5 /pool.h
parentee03f15f277645cf5b6a56f51b591a574d43e993 (diff)
downloadopenttd-fca58232381453f503ed9d92b40fd65c3c57bdb6.tar.xz
(svn r3805) - [FS#62] Fix doxygen comments to refer to the correct parameter. (sulai)
Diffstat (limited to 'pool.h')
-rw-r--r--pool.h16
1 files changed, 8 insertions, 8 deletions
diff --git a/pool.h b/pool.h
index 1994a441d..179ec7dc8 100644
--- a/pool.h
+++ b/pool.h
@@ -14,19 +14,19 @@ typedef void MemoryPoolNewBlock(uint start_item);
* please try to avoid manual calls!
*/
struct MemoryPool {
- const char name[10]; //! Name of the pool (just for debugging)
+ const char name[10]; ///< Name of the pool (just for debugging)
- const uint max_blocks; //! The max amount of blocks this pool can have
- const uint block_size_bits; //! The size of each block in bits
- const uint item_size; //! How many bytes one block is
+ const uint max_blocks; ///< The max amount of blocks this pool can have
+ const uint block_size_bits; ///< The size of each block in bits
+ const uint item_size; ///< How many bytes one block is
+ /// Pointer to a function that is called after a new block is added
MemoryPoolNewBlock *new_block_proc;
- //!< Pointer to a function that is called after a new block is added
- uint current_blocks; //! How many blocks we have in our pool
- uint total_items; //! How many items we now have in this pool
+ uint current_blocks; ///< How many blocks we have in our pool
+ uint total_items; ///< How many items we now have in this pool
- byte **blocks; //! An array of blocks (one block hold all the items)
+ byte **blocks; ///< An array of blocks (one block hold all the items)
};
/**