(svn r8950) -Cleanup: doxygen changes. Mostly @files missing tags and a few comments style.

This commit is contained in:
belugas
2007-03-01 01:24:44 +00:00
parent 66487d59fd
commit 978d7da818
23 changed files with 338 additions and 272 deletions

View File

@@ -1,5 +1,7 @@
/* $Id$ */
/** @file heightmap.h */
#ifndef HEIGHTMAP_H
#define HEIGHTMAP_H
@@ -8,12 +10,15 @@
* Otherwise you will get inconsistent behaviour.
*/
enum {
HM_COUNTER_CLOCKWISE, //! Rotate the map counter clockwise 45 degrees
HM_CLOCKWISE, //! Rotate the map clockwise 45 degrees
HM_COUNTER_CLOCKWISE, ///< Rotate the map counter clockwise 45 degrees
HM_CLOCKWISE, ///< Rotate the map clockwise 45 degrees
};
/**
* Get the dimensions of a heightmap.
* @param filename to query
* @param x dimension x
* @param y dimension y
* @return Returns false if loading of the image failed.
*/
bool GetHeightmapDimensions(char *filename, uint *x, uint *y);
@@ -22,11 +27,13 @@ bool GetHeightmapDimensions(char *filename, uint *x, uint *y);
* Load a heightmap from file and change the map in his current dimensions
* to a landscape representing the heightmap.
* It converts pixels to height. The brighter, the higher.
* @param filename of the heighmap file to be imported
*/
void LoadHeightmap(char *filename);
/**
* Make an empty world where all tiles are of height 'tile_height'.
* @param tile_height of the desired new empty world
*/
void FlatEmptyWorld(byte tile_height);