From 8282b66b70e16057049cdbe2a2ef65314cd52679 Mon Sep 17 00:00:00 2001
From: alberth <alberth@openttd.org>
Date: Sun, 26 Dec 2010 17:47:00 +0000
Subject: (svn r21645) -Doc: Document SmallPair and SmallMap template
 parameters.

---
 src/core/smallmap_type.hpp | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

(limited to 'src/core')

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>
-- 
cgit v1.2.3-54-g00ecf