summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoralberth <alberth@openttd.org>2009-04-18 15:03:02 +0000
committeralberth <alberth@openttd.org>2009-04-18 15:03:02 +0000
commit099281d7e4a4ed821dff4d2198cbc0ae1bdc80bb (patch)
treeb84bcbfa3cee4c2f7482b17eb40f95ccba6255c0
parent2fa61c6af79c33021d8e77f4bb58bda34b483551 (diff)
downloadopenttd-099281d7e4a4ed821dff4d2198cbc0ae1bdc80bb.tar.xz
(svn r16081) -Doc: Adding/fixing some Doxygen comments.
-rw-r--r--src/order_gui.cpp6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/order_gui.cpp b/src/order_gui.cpp
index 51a41f6bc..4b7b75f58 100644
--- a/src/order_gui.cpp
+++ b/src/order_gui.cpp
@@ -28,6 +28,7 @@
#include "table/sprites.h"
#include "table/strings.h"
+/** Widget numbers of the order window. */
enum OrderWindowWidgets {
ORDER_WIDGET_CLOSEBOX = 0,
ORDER_WIDGET_CAPTION,
@@ -375,6 +376,7 @@ static Order GetOrderCmdFromTile(const Vehicle *v, TileIndex tile)
return order;
}
+/** Order window code. */
struct OrdersWindow : public Window {
private:
static const int ORDER_LIST_LINE_HEIGHT = 10; ///< Height of a line in the ORDER_WIDGET_ORDER_LIST panel.
@@ -406,9 +408,7 @@ private:
* the position of the scrollbar.
*
* @param y Y-value of the click relative to the window origin
- * @param v current vehicle
- * @return the new selected order if the order is valid else return that
- * an invalid one has been selected.
+ * @return The selected order if the order is valid, else return \c INVALID_ORDER.
*/
int GetOrderFromPt(int y)
{