summaryrefslogtreecommitdiff
path: root/src/heightmap.h
diff options
context:
space:
mode:
authorbelugas <belugas@openttd.org>2007-03-01 01:24:44 +0000
committerbelugas <belugas@openttd.org>2007-03-01 01:24:44 +0000
commit978d7da81883c775c45b1bac64ce8b73f58d6d2f (patch)
treeb54eae356dabaadef12af40bb13f3e6e4f25c59e /src/heightmap.h
parent66487d59fd5fdeb253361865cb4322347b0b18fb (diff)
downloadopenttd-978d7da81883c775c45b1bac64ce8b73f58d6d2f.tar.xz
(svn r8950) -Cleanup: doxygen changes. Mostly @files missing tags and a few comments style.
Diffstat (limited to 'src/heightmap.h')
-rw-r--r--src/heightmap.h11
1 files changed, 9 insertions, 2 deletions
diff --git a/src/heightmap.h b/src/heightmap.h
index d7592bf27..5cf66e7ce 100644
--- a/src/heightmap.h
+++ b/src/heightmap.h
@@ -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);