mirror
/
OpenTTD
mirror of https://github.com/OpenTTD/OpenTTD
1
0
Fork 0
Code Issues

(svn r21645) -Doc: Document SmallPair and SmallMap template parameters.

release/1.1
alberth 2010-12-26 17:47:00 +00:00
parent 28f16a732f
commit 8282b66b70
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/core/smallmap_type.hpp
View File

@ -15,7 +15,11 @@
#include "smallvec_type.hpp" #include "smallvec_type.hpp"
#include "sort_func.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> template <typename T, typename U>
struct SmallPair { struct SmallPair {
T first; T first;
@ -28,6 +32,10 @@ struct SmallPair {
/** /**
* Implementation of simple mapping class. Both types have to be POD ("Plain Old Data")! * Implementation of simple mapping class. Both types have to be POD ("Plain Old Data")!
* It has inherited accessors from SmallVector(). * It has inherited accessors from SmallVector().
* @tvar T Key type.
* @tvar U Value type.
* @tvar S Unit of allocation.
*
* @see SmallVector * @see SmallVector
*/ */
template <typename T, typename U, uint S = 16> template <typename T, typename U, uint S = 16>