summaryrefslogtreecommitdiff
path: root/src/linkgraph
diff options
context:
space:
mode:
authorCharles Pigott <charlespigott@googlemail.com>2018-10-28 02:17:36 +0000
committerfrosch <github@elsenhans.name>2018-10-31 12:35:54 +0100
commitf5b1115039e41d7f75f91e7355003f10dd01b352 (patch)
treec777655761bcdca584fe0ff5c2f0e87fc2ef14e8 /src/linkgraph
parentb9273cbe07aa47daa8a9d2411062dfd7fead27de (diff)
downloadopenttd-f5b1115039e41d7f75f91e7355003f10dd01b352.tar.xz
Doc: Lots and lots of doxymentation fixes
Diffstat (limited to 'src/linkgraph')
-rw-r--r--src/linkgraph/demands.cpp1
-rw-r--r--src/linkgraph/demands.h2
-rw-r--r--src/linkgraph/flowmapper.cpp2
-rw-r--r--src/linkgraph/linkgraph.cpp2
-rw-r--r--src/linkgraph/linkgraph_gui.cpp2
-rw-r--r--src/linkgraph/mcf.cpp4
6 files changed, 5 insertions, 8 deletions
diff --git a/src/linkgraph/demands.cpp b/src/linkgraph/demands.cpp
index f4afbabf0..f1b714820 100644
--- a/src/linkgraph/demands.cpp
+++ b/src/linkgraph/demands.cpp
@@ -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; }
};
diff --git a/src/linkgraph/demands.h b/src/linkgraph/demands.h
index c3d9dc7cd..8a639b8b1 100644
--- a/src/linkgraph/demands.h
+++ b/src/linkgraph/demands.h
@@ -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); }
diff --git a/src/linkgraph/flowmapper.cpp b/src/linkgraph/flowmapper.cpp
index 4b974a809..b78b30335 100644
--- a/src/linkgraph/flowmapper.cpp
+++ b/src/linkgraph/flowmapper.cpp
@@ -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
{
diff --git a/src/linkgraph/linkgraph.cpp b/src/linkgraph/linkgraph.cpp
index 50945d361..34b3a4aa0 100644
--- a/src/linkgraph/linkgraph.cpp
+++ b/src/linkgraph/linkgraph.cpp
@@ -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.
diff --git a/src/linkgraph/linkgraph_gui.cpp b/src/linkgraph/linkgraph_gui.cpp
index c91fa2058..30c4451ee 100644
--- a/src/linkgraph/linkgraph_gui.cpp
+++ b/src/linkgraph/linkgraph_gui.cpp
@@ -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;
diff --git a/src/linkgraph/mcf.cpp b/src/linkgraph/mcf.cpp
index ecdf792af..544584ef6 100644
--- a/src/linkgraph/mcf.cpp
+++ b/src/linkgraph/mcf.cpp
@@ -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.