From 6c4e7ab51dbac9089644b2d7388092a6027c6223 Mon Sep 17 00:00:00 2001 From: fonsinchen Date: Tue, 22 Oct 2013 19:25:29 +0000 Subject: (svn r25908) -Fix: Some documentation for constructors of LinkRefresher::Hop. --- src/linkgraph/refresh.h | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'src') 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; }; -- cgit v1.2.3-70-g09d2