Mercurial > hg > openttd
changeset 16910:b240ff5ff2eb draft
(svn r21645) -Doc: Document SmallPair and SmallMap template parameters.
author | alberth <alberth@openttd.org> |
---|---|
date | Sun, 26 Dec 2010 17:47:00 +0000 |
parents | c9e234b35f82 |
children | ae401d0b5ce2 |
files | src/core/smallmap_type.hpp |
diffstat | 1 files changed, 9 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- 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 @@ /** * 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>