Mercurial > hg > openttd

changeset 13839:c7b24c5fdfde draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
(svn r18368) -Fix: alignment of comment and 'add' some missing comments
author rubidium <rubidium@openttd.org>
date Wed, 02 Dec 2009 00:01:07 +0000
parents 28a65ccd2115
children 9593e51e35f8
files src/pathfinder/npf/npf.cpp src/pathfinder/npf/npf_func.h src/pathfinder/opf/opf_ship.h src/pathfinder/yapf/yapf.h
diffstat 4 files changed, 21 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/src/pathfinder/npf/npf.cpp
+++ b/src/pathfinder/npf/npf.cpp
@@ -1133,9 +1133,9 @@
 	NPFFoundTargetData ftd = NPFRouteToStationOrTile(tile - TileOffsByDiagDir(enterdir), trackdir, true, &fstd, TRANSPORT_WATER, 0, v->owner, INVALID_RAILTYPES);
 
 	/* If ftd.best_bird_dist is 0, we found our target and ftd.best_trackdir contains
-		* the direction we need to take to get there, if ftd.best_bird_dist is not 0,
-		* we did not find our target, but ftd.best_trackdir contains the direction leading
-		* to the tile closest to our target. */
+	 * the direction we need to take to get there, if ftd.best_bird_dist is not 0,
+	 * we did not find our target, but ftd.best_trackdir contains the direction leading
+	 * to the tile closest to our target. */
 	if (ftd.best_trackdir == 0xff) return INVALID_TRACK;
 	return TrackdirToTrack(ftd.best_trackdir);
 }
--- a/src/pathfinder/npf/npf_func.h
+++ b/src/pathfinder/npf/npf_func.h
@@ -12,6 +12,14 @@
 #ifndef NPF_FUNC_H
 #define NPF_FUNC_H
 
+/**
+ * Finds the best path for given ship using NPF.
+ * @param v        the ship that needs to find a path
+ * @param tile     the tile to find the path from (should be next tile the ship is about to enter)
+ * @param enterdir diagonal direction which the ship will enter this new tile from
+ * @param tracks   available tracks on the new tile (to choose from)
+ * @return         the best trackdir for next turn or INVALID_TRACK if the path could not be found
+ */
 Track NPFShipChooseTrack(class Ship *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks);
 
 #endif /* NPF_FUNC_H */
--- a/src/pathfinder/opf/opf_ship.h
+++ b/src/pathfinder/opf/opf_ship.h
@@ -12,6 +12,14 @@
 #ifndef OPF_SHIP_H
 #define OPF_SHIP_H
 
+/**
+ * Finds the best path for given ship using OPF.
+ * @param v        the ship that needs to find a path
+ * @param tile     the tile to find the path from (should be next tile the ship is about to enter)
+ * @param enterdir diagonal direction which the ship will enter this new tile from
+ * @param tracks   available tracks on the new tile (to choose from)
+ * @return         the best trackdir for next turn or INVALID_TRACK if the path could not be found
+ */
 Track OPFShipChooseTrack(Ship *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks);
 
 #endif /* OPF_SHIP_H */
--- a/src/pathfinder/yapf/yapf.h
+++ b/src/pathfinder/yapf/yapf.h
@@ -15,7 +15,8 @@
 #include "../../direction_type.h"
 #include "../../station_type.h"
 
-/** Finds the best path for given ship.
+/**
+ * Finds the best path for given ship using YAPF.
  * @param v        the ship that needs to find a path
  * @param tile     the tile to find the path from (should be next tile the ship is about to enter)
  * @param enterdir diagonal direction which the ship will enter this new tile from