summaryrefslogtreecommitdiff
path: root/src/waypoint.h
diff options
context:
space:
mode:
authorbelugas <belugas@openttd.org>2007-04-06 04:10:19 +0000
committerbelugas <belugas@openttd.org>2007-04-06 04:10:19 +0000
commitd4d5ce7ee56c91a5dd84cbb0b5d1df54e1c20b9f (patch)
treea1e7d7ce47984afb0335e16c0f45d7edc5977704 /src/waypoint.h
parent15d360c7f6c9519a49b1210ce3100534eaf3001b (diff)
downloadopenttd-d4d5ce7ee56c91a5dd84cbb0b5d1df54e1c20b9f.tar.xz
(svn r9568) -Documentation: doxygen and comment changes: Root of src is finally done. Now, time to start clearing as much as possible
Diffstat (limited to 'src/waypoint.h')
-rw-r--r--src/waypoint.h4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/waypoint.h b/src/waypoint.h
index 2a34d1104..9f268bfd6 100644
--- a/src/waypoint.h
+++ b/src/waypoint.h
@@ -1,5 +1,7 @@
/* $Id$ */
+/** @file waypoint.h */
+
#ifndef WAYPOINT_H
#define WAYPOINT_H
@@ -28,6 +30,8 @@ DECLARE_OLD_POOL(Waypoint, Waypoint, 3, 8000)
/**
* Check if a Waypoint really exists.
+ * @param wp Waypoint to query
+ * @return the validity of the waypoint
*/
static inline bool IsValidWaypoint(const Waypoint *wp)
{