(svn r20483) -Doc: RefitOption operators.

1 files changed, 10 insertions, 0 deletions

diff --git a/src/vehicle_gui.cpp b/src/vehicle_gui.cpp
index d8ada1d62..ddebfeb48 100644
--- a/src/vehicle_gui.cpp
+++ b/src/vehicle_gui.cpp
@@ -284,11 +284,21 @@ struct RefitOption {
 	uint16 value;     ///< GRF-local String to display for the cargo
 	EngineID engine;  ///< Engine for which to resolve #value
 
+	/**
+	 * Inequality operator for #RefitOption.
+	 * @param other Compare to this #RefitOption.
+	 * @return True if both #RefitOption are different.
+	 */
 	FORCEINLINE bool operator != (const RefitOption &other) const
 	{
 		return other.cargo != this->cargo || other.value != this->value;
 	}
 
+	/**
+	 * Equality operator for #RefitOption.
+	 * @param other Compare to this #RefitOption.
+	 * @return True if both #RefitOption are equal.
+	 */
 	FORCEINLINE bool operator == (const RefitOption &other) const
 	{
 		return other.cargo == this->cargo && other.value == this->value;