summaryrefslogtreecommitdiff
path: root/src/pathfinder/yapf/yapf_base.hpp
diff options
context:
space:
mode:
authorfrosch <frosch@openttd.org>2010-08-01 19:22:34 +0000
committerfrosch <frosch@openttd.org>2010-08-01 19:22:34 +0000
commited4f806f1dcff2e10d2fdfb687e6bcebe9a81af3 (patch)
treedba65e1ae2fc4538779195db320eccfa441cbbd0 /src/pathfinder/yapf/yapf_base.hpp
parent4871baf44db96137cf4b72c4f9d9595b2c29f61d (diff)
downloadopenttd-ed4f806f1dcff2e10d2fdfb687e6bcebe9a81af3.tar.xz
(svn r20283) -Codechange: Unify start of doygen comments.
Diffstat (limited to 'src/pathfinder/yapf/yapf_base.hpp')
-rw-r--r--src/pathfinder/yapf/yapf_base.hpp15
1 files changed, 10 insertions, 5 deletions
diff --git a/src/pathfinder/yapf/yapf_base.hpp b/src/pathfinder/yapf/yapf_base.hpp
index cbebb31ec..f98a5163a 100644
--- a/src/pathfinder/yapf/yapf_base.hpp
+++ b/src/pathfinder/yapf/yapf_base.hpp
@@ -17,7 +17,8 @@
extern int _total_pf_time_us;
-/** CYapfBaseT - A-star type path finder base class.
+/**
+ * CYapfBaseT - A-star type path finder base class.
* Derive your own pathfinder from it. You must provide the following template argument:
* Types - used as collection of local types used in pathfinder
*
@@ -108,7 +109,8 @@ public:
return *m_settings;
}
- /** Main pathfinder routine:
+ /**
+ * Main pathfinder routine:
* - set startup node(s)
* - main loop that stops if:
* - the destination was found
@@ -174,7 +176,8 @@ public:
return bDestFound;
}
- /** If path was found return the best node that has reached the destination. Otherwise
+ /**
+ * If path was found return the best node that has reached the destination. Otherwise
* return the best visited node (which was nearest to the destination).
*/
FORCEINLINE Node *GetBestNode()
@@ -182,7 +185,8 @@ public:
return (m_pBestDestNode != NULL) ? m_pBestDestNode : m_pBestIntermediateNode;
}
- /** Calls NodeList::CreateNewNode() - allocates new node that can be filled and used
+ /**
+ * Calls NodeList::CreateNewNode() - allocates new node that can be filled and used
* as argument for AddStartupNode() or AddNewNode()
*/
FORCEINLINE Node& CreateNewNode()
@@ -217,7 +221,8 @@ public:
}
}
- /** AddNewNode() - called by Tderived::PfFollowNode() for each child node.
+ /**
+ * AddNewNode() - called by Tderived::PfFollowNode() for each child node.
* Nodes are evaluated here and added into open list */
void AddNewNode(Node &n, const TrackFollower &tf)
{