summaryrefslogtreecommitdiff
path: root/src/landscape.h
diff options
context:
space:
mode:
authorrubidium <rubidium@openttd.org>2008-10-19 15:39:12 +0000
committerrubidium <rubidium@openttd.org>2008-10-19 15:39:12 +0000
commitd832626bb9f8009c636c3ebef0620ead499ef8d3 (patch)
tree2a5381abe13a96fd46089d41193bd7b605164edc /src/landscape.h
parent15eb140d28a8fc131dedc595c7685562917130a4 (diff)
downloadopenttd-d832626bb9f8009c636c3ebef0620ead499ef8d3.tar.xz
(svn r14491) -Documentation: updates/additions of doxygen docs (Alberth)
Diffstat (limited to 'src/landscape.h')
-rw-r--r--src/landscape.h10
1 files changed, 6 insertions, 4 deletions
diff --git a/src/landscape.h b/src/landscape.h
index 4e2db7735..79edaec6b 100644
--- a/src/landscape.h
+++ b/src/landscape.h
@@ -11,13 +11,15 @@
#include "direction_type.h"
enum {
- SNOW_LINE_MONTHS = 12,
- SNOW_LINE_DAYS = 32,
+ SNOW_LINE_MONTHS = 12, ///< Number of months in the snow line table.
+ SNOW_LINE_DAYS = 32, ///< Number of days in each month in the snow line table.
};
+/** Structure describing the height of the snow line each day of the year
+ * @ingroup SnowLineGroup */
struct SnowLine {
- byte table[SNOW_LINE_MONTHS][SNOW_LINE_DAYS];
- byte highest_value;
+ byte table[SNOW_LINE_MONTHS][SNOW_LINE_DAYS]; ///< Height of the snow line each day of the year
+ byte highest_value; ///< Highest snow line of the year
};
bool IsSnowLineSet(void);