(svn r20283) -Codechange: Unify start of doygen comments.

src/core/bitmath_func.hpp

@@ -34,7 +34,8 @@ static FORCEINLINE uint GB(const T x, const uint8 s, const uint8 n)
 	return (x >> s) & ((1U << n) - 1);
 }
 
-/** Set \a n bits in \a x starting at bit \a s to \a d
+/**
+ * Set \a n bits in \a x starting at bit \a s to \a d
  *
  * This function sets \a n bits from \a x which started as bit \a s to the value of
  * \a d. The parameters \a x, \a s and \a n works the same as the parameters of
@@ -59,7 +60,8 @@ static FORCEINLINE T SB(T &x, const uint8 s, const uint8 n, const U d)
 	return x;
 }
 
-/** Add i to n bits of x starting at bit s.
+/**
+ * Add i to n bits of x starting at bit s.
  *
  * This add the value of i on n bits of x starting at bit s. The parameters x,
  * s, i are similar to #GB besides x must be a variable as the result are

src/core/enum_type.hpp

@@ -40,7 +40,8 @@
 	FORCEINLINE mask_t operator ~(mask_t m) {return (mask_t)(~(int)m);}
 
 
-/** Informative template class exposing basic enumeration properties used by several
+/**
+ * Informative template class exposing basic enumeration properties used by several
  *  other templates below. Here we have only forward declaration. For each enum type
  *  we will create specialization derived from MakeEnumPropsT<>.
  *  i.e.:
@@ -50,7 +51,8 @@
  */
 template <typename Tenum_t> struct EnumPropsT;
 
-/** Helper template class that makes basic properties of given enumeration type visible
+/**
+ * Helper template class that makes basic properties of given enumeration type visible
  *  from outsize. It is used as base class of several EnumPropsT specializations each
  *  dedicated to one of commonly used enumeration types.
  *  @param Tenum_t enumeration type that you want to describe
@@ -72,7 +74,8 @@ struct MakeEnumPropsT {
 
 
 
-/** In some cases we use byte or uint16 to store values that are defined as enum. It is
+/**
+ * In some cases we use byte or uint16 to store values that are defined as enum. It is
  *  necessary in order to control the sizeof() such values. Some compilers make enum
  *  the same size as int (4 or 8 bytes instead of 1 or 2). As a consequence the strict
  *  compiler type - checking causes errors like:

src/core/random_func.hpp

@@ -65,7 +65,8 @@ struct SavedRandomSeeds {
 	Randomizer interactive_random;
 };
 
-/** Saves the current seeds
+/**
+ * Saves the current seeds
  * @param storage Storage for saving
  */
 static inline void SaveRandomSeeds(SavedRandomSeeds *storage)
@@ -74,7 +75,8 @@ static inline void SaveRandomSeeds(SavedRandomSeeds *storage)
 	storage->interactive_random = _interactive_random;
 }
 
-/** Restores previously saved seeds
+/**
+ * Restores previously saved seeds
  * @param storage Storage where SaveRandomSeeds() stored th seeds
  */
 static inline void RestoreRandomSeeds(const SavedRandomSeeds &storage)

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