From da93ffba6c2a72fe2b5dd2598435e47fe30e1fd1 Mon Sep 17 00:00:00 2001
From: johns <>
Date: Mon, 19 Feb 2001 17:59:53 +0000
Subject: [PATCH] Changed @returns to correct doc++/doxygen keyword @return.
Changed return value of NewPath.
---
src/pathfinder/astar.cpp | 21 +++++++++++----------
1 file changed, 11 insertions(+), 10 deletions(-)
diff --git a/src/pathfinder/astar.cpp b/src/pathfinder/astar.cpp
index e52ce9bae..4f6ce83a0 100644
--- a/src/pathfinder/astar.cpp
+++ b/src/pathfinder/astar.cpp
@@ -30,6 +30,10 @@
#include "pathfinder.h"
+/*----------------------------------------------------------------------------
+-- Declarations
+----------------------------------------------------------------------------*/
+
typedef struct _node_ {
short Direction; /// Direction for trace back
short InGoal; /// is this point in the goal
@@ -46,6 +50,10 @@ typedef struct _open_ {
/// heuristic cost fonction for a star
#define AStarCosts(sx,sy,ex,ey) max(abs(sx-ex),abs(sy-ey))
+/*----------------------------------------------------------------------------
+-- Variables
+----------------------------------------------------------------------------*/
+
/// cost matrix
local Node *AStarMatrix;
/// a list of close nodes, helps to speed up the matrix cleaning
@@ -541,7 +549,7 @@ local int AStarFindPath(Unit* unit,int* pxd,int* pyd)
** @param pxd Pointer for the x direction.
** @param pyd Pointer for the y direction.
**
-** @returns >0 remaining path length, 0 wait for path, -1
+** @return >0 remaining path length, 0 wait for path, -1
** reached goal, -2 can't reach the goal.
*/
global int AStarNextPathElement(Unit* unit,int* pxd,int *pyd)
@@ -605,7 +613,7 @@ global int AStarNextPathElement(Unit* unit,int* pxd,int *pyd)
** @param pxd Pointer for the x direction.
** @param pyd Pointer for the y direction.
**
-** @returns >0 remaining path length, 0 wait for path, -1
+** @return >0 remaining path length, 0 wait for path, -1
** reached goal, -2 can't reach the goal.
*/
global int NextPathElement(Unit* unit,int* pxd,int *pyd)
@@ -614,14 +622,7 @@ global int NextPathElement(Unit* unit,int* pxd,int *pyd)
if(AStarOn) {
return AStarNextPathElement(unit,pxd,pyd);
} else {
- switch( NewPath(unit,pxd,pyd) ) {
- case 0:
- return 999;
- case 1:
- return -1;
- default:
- return -2;
- }
+ return NewPath(unit,pxd,pyd);
}
}