src/depot.h
branchcpp_gui
changeset 6268 4b5241e5dd10
parent 5726 8f399788f6c9
child 6285 187e3ef04cc9
--- a/src/depot.h	Tue Feb 27 23:54:28 2007 +0000
+++ b/src/depot.h	Wed Feb 28 00:33:40 2007 +0000
@@ -1,11 +1,10 @@
 /* $Id$ */
 
+/** @file depot.h Header files for depots (not hangars) */
+
 #ifndef DEPOT_H
 #define DEPOT_H
 
-/** @file depot.h Header files for depots (not hangars)
- *  @see depot.c */
-
 #include "direction.h"
 #include "oldpool.h"
 #include "tile.h"
@@ -55,6 +54,7 @@
  * Get the new proposed service interval for the vehicle is indeed, clamped
  * within the given bounds. @see MIN_SERVINT_PERCENT ,etc.
  * @param index proposed service interval
+ * @return service interval
  */
 static inline Date GetServiceIntervalClamped(uint index)
 {
@@ -85,7 +85,7 @@
 
 /**
  * Find out if the slope of the tile is suitable to build a depot of given direction
- * @param direction The direction in which the depot's exit points. Starts with 0 as NE and goes Clockwise
+ * @param direction The direction in which the depot's exit points
  * @param tileh The slope of the tile in question
  * @return true if the construction is possible
 
@@ -98,7 +98,7 @@
  * 03 (exit towards NW) we need either bit 0 or 4 set in tileh: 0x4C >> 3 = 1001<p>
  * So ((0x4C >> direction) & tileh) determines whether the depot can be built on the current tileh
  */
-static inline bool CanBuildDepotByTileh(uint32 direction, Slope tileh)
+static inline bool CanBuildDepotByTileh(DiagDirection direction, Slope tileh)
 {
 	return ((0x4C >> direction) & tileh) != 0;
 }