diff options
| author | frosch <frosch@openttd.org> | 2010-08-01 19:22:34 +0000 |
|---|---|---|
| committer | frosch <frosch@openttd.org> | 2010-08-01 19:22:34 +0000 |
| commit | ed4f806f1dcff2e10d2fdfb687e6bcebe9a81af3 (patch) | |
| tree | dba65e1ae2fc4538779195db320eccfa441cbbd0 /src/core/smallmap_type.hpp | |
| parent | 4871baf44db96137cf4b72c4f9d9595b2c29f61d (diff) | |
| download | openttd-ed4f806f1dcff2e10d2fdfb687e6bcebe9a81af3.tar.xz | |
(svn r20283) -Codechange: Unify start of doygen comments.
Diffstat (limited to 'src/core/smallmap_type.hpp')
| -rw-r--r-- | src/core/smallmap_type.hpp | 18 |
1 files changed, 12 insertions, 6 deletions
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 |