summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrubidium <rubidium@openttd.org>2009-10-21 15:40:50 +0000
committerrubidium <rubidium@openttd.org>2009-10-21 15:40:50 +0000
commit0ebe525e5bb4c0953bc60350c0dfeaf40112920f (patch)
tree2b1cf9599565ad464801af7451630054959100d2
parenta4d054eabc8b2087b60ae57ce57a177a5dde1bc0 (diff)
downloadopenttd-0ebe525e5bb4c0953bc60350c0dfeaf40112920f.tar.xz
(svn r17838) -Document: the Pool struct's template parameters
-rw-r--r--src/core/pool_type.hpp12
1 files changed, 11 insertions, 1 deletions
diff --git a/src/core/pool_type.hpp b/src/core/pool_type.hpp
index c9b1e3772..728678515 100644
--- a/src/core/pool_type.hpp
+++ b/src/core/pool_type.hpp
@@ -12,6 +12,13 @@
#ifndef POOL_TYPE_HPP
#define POOL_TYPE_HPP
+/**
+ * Base class for all pools.
+ * @tparam Titem Type of the class/struct that is going to be pooled
+ * @tparam Tindex Type of the index for this pool
+ * @tparam Tgrowth_step Size of growths; if the pool is full increase the size by this amount
+ * @tparam Tmax_size Maximum size of the pool
+ */
template <class Titem, typename Tindex, size_t Tgrowth_step, size_t Tmax_size>
struct Pool {
static const size_t MAX_SIZE = Tmax_size; ///< Make template parameter accessible from outside
@@ -64,7 +71,10 @@ struct Pool {
return this->items <= Tmax_size - n;
}
- /** Base class for all PoolItems */
+ /**
+ * Base class for all PoolItems
+ * @tparam Tpool The pool this item is going to be part of
+ */
template <struct Pool<Titem, Tindex, Tgrowth_step, Tmax_size> *Tpool>
struct PoolItem {
Tindex index; ///< Index of this pool item