diff options
| author | alberth <alberth@openttd.org> | 2010-12-26 17:47:00 +0000 |
|---|---|---|
| committer | alberth <alberth@openttd.org> | 2010-12-26 17:47:00 +0000 |
| commit | 8282b66b70e16057049cdbe2a2ef65314cd52679 (patch) | |
| tree | 8f3d472e452bc9ba8feb07eca5df0cf20d50d792 | |
| parent | 28f16a732fbcc759c9cceef7c9a160486b37f896 (diff) | |
| download | openttd-8282b66b70e16057049cdbe2a2ef65314cd52679.tar.xz | |
(svn r21645) -Doc: Document SmallPair and SmallMap template parameters.
| -rw-r--r-- | src/core/smallmap_type.hpp | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/src/core/smallmap_type.hpp b/src/core/smallmap_type.hpp index 7c0186689..f72a8800d 100644 --- a/src/core/smallmap_type.hpp +++ b/src/core/smallmap_type.hpp @@ -15,7 +15,11 @@ #include "smallvec_type.hpp" #include "sort_func.hpp" -/** Simple pair of data. Both types have to be POD ("Plain Old Data")! */ +/** + * Simple pair of data. Both types have to be POD ("Plain Old Data")! + * @tvar T Key type. + * @tvar U Value type. + */ template <typename T, typename U> struct SmallPair { T first; @@ -28,6 +32,10 @@ struct SmallPair { /** * Implementation of simple mapping class. Both types have to be POD ("Plain Old Data")! * It has inherited accessors from SmallVector(). + * @tvar T Key type. + * @tvar U Value type. + * @tvar S Unit of allocation. + * * @see SmallVector */ template <typename T, typename U, uint S = 16> |