Doc: Lots and lots of doxymentation fixes
This commit is contained in:
@@ -115,7 +115,6 @@ public:
|
||||
* Check if there is any acceptance left for this node. In asymmetric distribution
|
||||
* nodes always accept as long as their demand > 0.
|
||||
* @param to The node to be checked.
|
||||
* @param to_anno Unused.
|
||||
*/
|
||||
inline bool HasDemandLeft(const Node &to) { return to.Demand() > 0; }
|
||||
};
|
||||
|
@@ -30,7 +30,7 @@ public:
|
||||
|
||||
/**
|
||||
* Call the demand calculator on the given component.
|
||||
* @param graph Component to calculate the demands for.
|
||||
* @param job Component to calculate the demands for.
|
||||
*/
|
||||
virtual void Run(LinkGraphJob &job) const { DemandCalculator c(job); }
|
||||
|
||||
|
@@ -16,7 +16,7 @@
|
||||
|
||||
/**
|
||||
* Map the paths generated by the MCF solver into flows associated with nodes.
|
||||
* @param component the link graph component to be used.
|
||||
* @param job the link graph component to be used.
|
||||
*/
|
||||
void FlowMapper::Run(LinkGraphJob &job) const
|
||||
{
|
||||
|
@@ -252,8 +252,6 @@ void LinkGraph::Node::RemoveEdge(NodeID to)
|
||||
* least the given capacity and usage, otherwise add the capacity and usage.
|
||||
* In any case set the respective update timestamp(s), according to the given
|
||||
* mode.
|
||||
* @param from Start node of the edge.
|
||||
* @param to End node of the edge.
|
||||
* @param capacity Capacity to be added/updated.
|
||||
* @param usage Usage to be added.
|
||||
* @param mode Update mode to be applied.
|
||||
|
@@ -425,7 +425,7 @@ LinkGraphLegendWindow::LinkGraphLegendWindow(WindowDesc *desc, int window_number
|
||||
|
||||
/**
|
||||
* Set the overlay belonging to this menu and import its company/cargo settings.
|
||||
* @params overlay New overlay for this menu.
|
||||
* @param overlay New overlay for this menu.
|
||||
*/
|
||||
void LinkGraphLegendWindow::SetOverlay(LinkGraphOverlay *overlay) {
|
||||
this->overlay = overlay;
|
||||
|
@@ -193,7 +193,7 @@ public:
|
||||
* Determines if an extension to the given Path with the given parameters is
|
||||
* better than this path.
|
||||
* @param base Other path.
|
||||
* @param cap Capacity of the new edge to be added to base.
|
||||
* @param free_cap Capacity of the new edge to be added to base.
|
||||
* @param dist Distance of the new edge.
|
||||
* @return True if base + the new edge would be better than the path associated
|
||||
* with this annotation.
|
||||
@@ -227,7 +227,7 @@ bool DistanceAnnotation::IsBetter(const DistanceAnnotation *base, uint cap,
|
||||
* Determines if an extension to the given Path with the given parameters is
|
||||
* better than this path.
|
||||
* @param base Other path.
|
||||
* @param cap Capacity of the new edge to be added to base.
|
||||
* @param free_cap Capacity of the new edge to be added to base.
|
||||
* @param dist Distance of the new edge.
|
||||
* @return True if base + the new edge would be better than the path associated
|
||||
* with this annotation.
|
||||
|
Reference in New Issue
Block a user