1
0
Fork 0

Doc: Update some yapf inline comments

pull/12295/merge
SamuXarick 2024-12-23 17:27:15 +00:00 committed by Kuhnovic
parent cd0e1fc47d
commit ee860a5c8e
5 changed files with 9 additions and 9 deletions

View File

@ -65,14 +65,14 @@ public:
/** Notify the nodelist that we don't want to discard the given node. */ /** Notify the nodelist that we don't want to discard the given node. */
inline void FoundBestNode(Titem &item) inline void FoundBestNode(Titem &item)
{ {
/* for now it is enough to invalidate m_new_node if it is our given node */ /* for now it is enough to invalidate new_node if it is our given node */
if (&item == this->new_node) { if (&item == this->new_node) {
this->new_node = nullptr; this->new_node = nullptr;
} }
/* TODO: do we need to store best nodes found in some extra list/array? Probably not now. */ /* TODO: do we need to store best nodes found in some extra list/array? Probably not now. */
} }
/** insert given item as open node (into m_open and m_open_queue) */ /** insert given item as open node (into open_nodes and open_queue) */
inline void InsertOpenNode(Titem &item) inline void InsertOpenNode(Titem &item)
{ {
assert(this->closed_nodes.Find(item.GetKey()) == nullptr); assert(this->closed_nodes.Find(item.GetKey()) == nullptr);

View File

@ -269,7 +269,7 @@ public:
/** /**
* Called by YAPF to calculate the cost from the origin to the given node. * Called by YAPF to calculate the cost from the origin to the given node.
* Calculates only the cost of given node, adds it to the parent node cost * Calculates only the cost of given node, adds it to the parent node cost
* and stores the result into Node::m_cost member * and stores the result into Node::cost member
*/ */
inline bool PfCalcCost(Node &n, const TrackFollower *tf) inline bool PfCalcCost(Node &n, const TrackFollower *tf)
{ {

View File

@ -109,7 +109,7 @@ public:
/** /**
* Called by YAPF to calculate the cost from the origin to the given node. * Called by YAPF to calculate the cost from the origin to the given node.
* Calculates only the cost of given node, adds it to the parent node cost * Calculates only the cost of given node, adds it to the parent node cost
* and stores the result into Node::m_cost member * and stores the result into Node::cost member
*/ */
inline bool PfCalcCost(Node &n, const TrackFollower *) inline bool PfCalcCost(Node &n, const TrackFollower *)
{ {
@ -211,7 +211,7 @@ public:
/** /**
* Called by YAPF to calculate cost estimate. Calculates distance to the destination * Called by YAPF to calculate cost estimate. Calculates distance to the destination
* adds it to the actual cost from origin and stores the sum to the Node::m_estimate * adds it to the actual cost from origin and stores the sum to the Node::estimate
*/ */
inline bool PfCalcEstimate(Node &n) inline bool PfCalcEstimate(Node &n)
{ {
@ -292,7 +292,7 @@ public:
/** /**
* Called by YAPF to calculate cost estimate. Calculates distance to the destination * Called by YAPF to calculate cost estimate. Calculates distance to the destination
* adds it to the actual cost from origin and stores the sum to the Node::m_estimate * adds it to the actual cost from origin and stores the sum to the Node::estimate
*/ */
inline bool PfCalcEstimate(Node &n) inline bool PfCalcEstimate(Node &n)
{ {

View File

@ -91,7 +91,7 @@ public:
/** /**
* Called by YAPF to calculate cost estimate. Calculates distance to the destination * Called by YAPF to calculate cost estimate. Calculates distance to the destination
* adds it to the actual cost from origin and stores the sum to the Node::m_estimate. * adds it to the actual cost from origin and stores the sum to the Node::estimate.
*/ */
inline bool PfCalcEstimate(Node &n) inline bool PfCalcEstimate(Node &n)
{ {
@ -367,7 +367,7 @@ public:
/** /**
* Called by YAPF to calculate the cost from the origin to the given node. * Called by YAPF to calculate the cost from the origin to the given node.
* Calculates only the cost of given node, adds it to the parent node cost * Calculates only the cost of given node, adds it to the parent node cost
* and stores the result into Node::m_cost member. * and stores the result into Node::cost member.
*/ */
inline bool PfCalcCost(Node &n, const TrackFollower *tf) inline bool PfCalcCost(Node &n, const TrackFollower *tf)
{ {

View File

@ -238,7 +238,7 @@ public:
/** /**
* Called by YAPF to calculate the cost from the origin to the given node. * Called by YAPF to calculate the cost from the origin to the given node.
* Calculates only the cost of given node, adds it to the parent node cost * Calculates only the cost of given node, adds it to the parent node cost
* and stores the result into Node::m_cost member. * and stores the result into Node::cost member.
*/ */
inline bool PfCalcCost(Node &n, const TrackFollower *) inline bool PfCalcCost(Node &n, const TrackFollower *)
{ {