(svn r21845) -Codechange: move documentation towards the code to make it more likely to be updates [d-m].

src/map.cpp

@@ -30,7 +30,7 @@ Tile *_m = NULL;          ///< Tiles of the map
 TileExtended *_me = NULL; ///< Extended Tiles of the map
 
 
-/*!
+/**
  * (Re)allocates a map with the given dimension
  * @param size_x the width of the map along the NE/SW edge
  * @param size_y the 'height' of the map along the SE/NW edge
@@ -97,7 +97,7 @@ TileIndex TileAdd(TileIndex tile, TileIndexDiff add,
 }
 #endif
 
-/*!
+/**
  * This function checks if we add addx/addy to tile, if we
  * do wrap around the edges. For example, tile = (10,2) and
  * addx = +3 and addy = -4. This function will now return
@@ -144,7 +144,7 @@ extern const TileIndexDiffC _tileoffs_by_dir[] = {
 	{ 0, -1}  ///< DIR_NW
 };
 
-/*!
+/**
  * Gets the Manhattan distance between the two given tiles.
  * The Manhattan distance is the sum of the delta of both the
  * X and Y component.
@@ -161,7 +161,7 @@ uint DistanceManhattan(TileIndex t0, TileIndex t1)
 }
 
 
-/*!
+/**
  * Gets the 'Square' distance between the two given tiles.
  * The 'Square' distance is the square of the shortest (straight line)
  * distance between the two tiles.
@@ -178,7 +178,7 @@ uint DistanceSquare(TileIndex t0, TileIndex t1)
 }
 
 
-/*!
+/**
  * Gets the biggest distance component (x or y) between the two given tiles.
  * Also known as L-Infinity-Norm.
  * @param t0 the start tile
@@ -193,7 +193,7 @@ uint DistanceMax(TileIndex t0, TileIndex t1)
 }
 
 
-/*!
+/**
  * Gets the biggest distance component (x or y) between the two given tiles
  * plus the Manhattan distance, i.e. two times the biggest distance component
  * and once the smallest component.
@@ -208,7 +208,7 @@ uint DistanceMaxPlusManhattan(TileIndex t0, TileIndex t1)
 	return dx > dy ? 2 * dx + dy : 2 * dy + dx;
 }
 
-/*!
+/**
  * Param the minimum distance to an edge
  * @param tile the tile to get the distance from
  * @return the distance from the edge in tiles
@@ -224,7 +224,7 @@ uint DistanceFromEdge(TileIndex tile)
 	return min(minl, minh);
 }
 
-/*!
+/**
  * Gets the distance to the edge of the map in given direction.
  * @param tile the tile to get the distance from
  * @param diagdir the direction of interest
@@ -241,7 +241,7 @@ uint DistanceFromEdgeDir(TileIndex tile, DiagDirection dir)
 	}
 }
 
-/*!
+/**
  * Function performing a search around a center tile and going outward, thus in circle.
  * Although it really is a square search...
  * Every tile will be tested by means of the callback function proc,
@@ -273,7 +273,7 @@ bool CircularTileSearch(TileIndex *tile, uint size, TestTileOnSearchProc proc, v
 	}
 }
 
-/*!
+/**
  * Generalized circular search allowing for rectangles and a hole.
  * Function performing a search around a center rectangle and going outward.
  * The center rectangle is left out from the search. To do a rectangular search
@@ -330,7 +330,7 @@ bool CircularTileSearch(TileIndex *tile, uint radius, uint w, uint h, TestTileOn
 	return false;
 }
 
-/*!
+/**
  * Finds the distance for the closest tile with water/land given a tile
  * @param tile  the tile to find the distance too
  * @param water whether to find water or land