(svn r25908) -Fix: Some documentation for constructors of LinkRefresher::Hop.

1 files changed, 12 insertions, 0 deletions

diff --git a/src/linkgraph/refresh.h b/src/linkgraph/refresh.h
index ba96aa559..ff9662224 100644
--- a/src/linkgraph/refresh.h
+++ b/src/linkgraph/refresh.h
@@ -60,7 +60,19 @@ protected:
 		OrderID from;  ///< Last order where vehicle could interact with cargo or absolute first order.
 		OrderID to;    ///< Next order to be processed.
 		CargoID cargo; ///< Cargo the consist is probably carrying or CT_INVALID if unknown.
+
+		/**
+		 * Default constructor should not be called but has to be visible for
+		 * usage in std::set.
+		 */
 		Hop() {NOT_REACHED();}
+
+		/**
+		 * Real constructor, only use this one.
+		 * @param from First order of the hop.
+		 * @param to Second order of the hop.
+		 * @param cargo Cargo the consist is probably carrying when passing the hop.
+		 */
 		Hop(OrderID from, OrderID to, CargoID cargo) : from(from), to(to), cargo(cargo) {}
 		bool operator<(const Hop &other) const;
 	};