From ed4f806f1dcff2e10d2fdfb687e6bcebe9a81af3 Mon Sep 17 00:00:00 2001
From: frosch <frosch@openttd.org>
Date: Sun, 1 Aug 2010 19:22:34 +0000
Subject: (svn r20283) -Codechange: Unify start of doygen comments.

---
 src/core/smallmap_type.hpp | 18 ++++++++++++------
 1 file changed, 12 insertions(+), 6 deletions(-)

(limited to 'src/core/smallmap_type.hpp')

diff --git a/src/core/smallmap_type.hpp b/src/core/smallmap_type.hpp
index 28000145e..8689447c1 100644
--- a/src/core/smallmap_type.hpp
+++ b/src/core/smallmap_type.hpp
@@ -25,7 +25,8 @@ struct SmallPair {
 	FORCEINLINE SmallPair(const T &first, const U &second) : first(first), second(second) { }
 };
 
-/** 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().
  * @see SmallVector
  */
@@ -40,7 +41,8 @@ struct SmallMap : SmallVector<SmallPair<T, U>, S> {
 	/** Data are freed in SmallVector destructor */
 	FORCEINLINE ~SmallMap() { }
 
-	/** Finds given key in this map
+	/**
+	 * Finds given key in this map
 	 * @param key key to find
 	 * @return &Pair(key, data) if found, this->End() if not
 	 */
@@ -52,7 +54,8 @@ struct SmallMap : SmallVector<SmallPair<T, U>, S> {
 		return this->End();
 	}
 
-	/** Removes given pair from this map
+	/**
+	 * Removes given pair from this map
 	 * @param pair pair to remove
 	 * @note it has to be pointer to pair in this map. It is overwritten by the last item.
 	 */
@@ -62,7 +65,8 @@ struct SmallMap : SmallVector<SmallPair<T, U>, S> {
 		*pair = this->data[--this->items];
 	}
 
-	/** Removes given key from this map
+	/**
+	 * Removes given key from this map
 	 * @param key key to remove
 	 * @return true iff the key was found
 	 * @note last item is moved to its place, so don't increase your iterator if true is returned!
@@ -78,7 +82,8 @@ struct SmallMap : SmallVector<SmallPair<T, U>, S> {
 		return false;
 	}
 
-	/** Adds new item to this map.
+	/**
+	 * Adds new item to this map.
 	 * @param key key
 	 * @param data data
 	 * @return true iff the key wasn't already present
@@ -92,7 +97,8 @@ struct SmallMap : SmallVector<SmallPair<T, U>, S> {
 		return true;
 	}
 
-	/** Returns data belonging to this key
+	/**
+	 * Returns data belonging to this key
 	 * @param key key
 	 * @return data belonging to this key
 	 * @note if this key wasn't present, new entry is created
-- 
cgit v1.2.3-54-g00ecf