diff src/pbs.h @ 17639:3cd4f18cdbc1 draft

(svn r22410) -Document: some more bits ;)
author rubidium <rubidium@openttd.org>
date Mon, 02 May 2011 16:14:23 +0000 (2011-05-02)
parents e4f2ba58a34f
children f8c0e108128c
line wrap: on
line diff
--- a/src/pbs.h
+++ b/src/pbs.h
@@ -30,7 +30,17 @@
 	Trackdir  trackdir;  ///< The reserved trackdir on the tile.
 	bool      okay;      ///< True if tile is a safe waiting position, false otherwise.
 
+	/**
+	 * Create an empty PBSTileInfo.
+	 */
 	PBSTileInfo() : tile(INVALID_TILE), trackdir(INVALID_TRACKDIR), okay(false) {}
+
+	/**
+	 * Create a PBSTileInfo with given tile, track direction and safe waiting position information.
+	 * @param _t The tile where the path ends.
+	 * @param _td The reserved track dir on the tile.
+	 * @param _okay Whether the tile is a safe waiting point or not.
+	 */
 	PBSTileInfo(TileIndex _t, Trackdir _td, bool _okay) : tile(_t), trackdir(_td), okay(_okay) {}
 };