diff options
author | Charles Pigott <charlespigott@googlemail.com> | 2018-10-28 02:17:36 +0000 |
---|---|---|
committer | frosch <github@elsenhans.name> | 2018-10-31 12:35:54 +0100 |
commit | f5b1115039e41d7f75f91e7355003f10dd01b352 (patch) | |
tree | c777655761bcdca584fe0ff5c2f0e87fc2ef14e8 /src/pathfinder/npf/aystar.h | |
parent | b9273cbe07aa47daa8a9d2411062dfd7fead27de (diff) | |
download | openttd-f5b1115039e41d7f75f91e7355003f10dd01b352.tar.xz |
Doc: Lots and lots of doxymentation fixes
Diffstat (limited to 'src/pathfinder/npf/aystar.h')
-rw-r--r-- | src/pathfinder/npf/aystar.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/src/pathfinder/npf/aystar.h b/src/pathfinder/npf/aystar.h index eaa70bf91..4ee9df332 100644 --- a/src/pathfinder/npf/aystar.h +++ b/src/pathfinder/npf/aystar.h @@ -30,7 +30,7 @@ enum AystarStatus { AYSTAR_EMPTY_OPENLIST, ///< All items are tested, and no path has been found. AYSTAR_STILL_BUSY, ///< Some checking was done, but no path found yet, and there are still items left to try. AYSTAR_NO_PATH, ///< No path to the goal was found. - AYSTAR_LIMIT_REACHED, ///< The #max_nodes limit has been reached, aborting search. + AYSTAR_LIMIT_REACHED, ///< The #AyStar::max_search_nodes limit has been reached, aborting search. AYSTAR_DONE, ///< Not an end-tile, or wrong direction. }; @@ -93,9 +93,9 @@ typedef int32 AyStar_CalculateG(AyStar *aystar, AyStarNode *current, OpenListNod typedef int32 AyStar_CalculateH(AyStar *aystar, AyStarNode *current, OpenListNode *parent); /** - * This function requests the tiles around the current tile and put them in #tiles_around. - * #tiles_around is never reset, so if you are not using directions, just leave it alone. - * \warning Never add more tiles_around than memory allocated for it. + * This function requests the tiles around the current tile and put them in #neighbours. + * #neighbours is never reset, so if you are not using directions, just leave it alone. + * @warning Never add more #neighbours than memory allocated for it. */ typedef void AyStar_GetNeighbours(AyStar *aystar, OpenListNode *current); |