diff options
| author | alberth <alberth@openttd.org> | 2010-11-20 14:15:02 +0000 |
|---|---|---|
| committer | alberth <alberth@openttd.org> | 2010-11-20 14:15:02 +0000 |
| commit | 3b0ee6557113104416f465fb780d9900fb7a842a (patch) | |
| tree | 4c6600efd2700df08b38c84cd594dd11043ee501 /src/bridge_gui.cpp | |
| parent | 5d72befbcd0486900062a4163c3eb52d5d27f7d5 (diff) | |
| download | openttd-3b0ee6557113104416f465fb780d9900fb7a842a.tar.xz | |
(svn r21270) -Doc: Doxyment updates and additions. Removal of doxyment in code.
Diffstat (limited to 'src/bridge_gui.cpp')
| -rw-r--r-- | src/bridge_gui.cpp | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/src/bridge_gui.cpp b/src/bridge_gui.cpp index 1b3058717..7c636928f 100644 --- a/src/bridge_gui.cpp +++ b/src/bridge_gui.cpp @@ -39,7 +39,7 @@ struct BuildBridgeData { Money cost; }; -typedef GUIList<BuildBridgeData> GUIBridgeList; +typedef GUIList<BuildBridgeData> GUIBridgeList; ///< List of bridges, used in #BuildBridgeWindow. /** * Callback executed after a build Bridge CMD has been called @@ -63,11 +63,12 @@ enum BuildBridgeSelectionWidgets { BBSW_SCROLLBAR, }; +/** Window class for handling the bridge-build GUI. */ class BuildBridgeWindow : public Window { private: /* Runtime saved values */ - static uint16 last_size; - static Listing last_sorting; + static uint16 last_size; ///< Last size of the bridge GUI window. + static Listing last_sorting; ///< Last setting of the sort. /* Constants for sorting the bridges */ static const StringID sorter_names[]; @@ -287,19 +288,19 @@ public: } }; -/* Set the default size of the Build Bridge Window */ +/** Set the default size of the Build Bridge Window. */ uint16 BuildBridgeWindow::last_size = 4; -/* Set the default sorting for the bridges */ +/** Set the default sorting for the bridges */ Listing BuildBridgeWindow::last_sorting = {false, 0}; -/* Availible bridge sorting functions */ +/** Available bridge sorting functions. */ GUIBridgeList::SortFunction * const BuildBridgeWindow::sorter_funcs[] = { &BridgeIndexSorter, &BridgePriceSorter, &BridgeSpeedSorter }; -/* Names of the sorting functions */ +/** Names of the sorting functions. */ const StringID BuildBridgeWindow::sorter_names[] = { STR_SORT_BY_NUMBER, STR_SORT_BY_COST, @@ -307,6 +308,7 @@ const StringID BuildBridgeWindow::sorter_names[] = { INVALID_STRING_ID }; +/** Widgets of the bridge gui. */ static const NWidgetPart _nested_build_bridge_widgets[] = { /* Header */ NWidget(NWID_HORIZONTAL), @@ -333,7 +335,7 @@ static const NWidgetPart _nested_build_bridge_widgets[] = { EndContainer(), }; -/* Window definition for the rail bridge selection window */ +/** Window definition for the rail bridge selection window. */ static const WindowDesc _build_bridge_desc( WDP_AUTO, 200, 114, WC_BUILD_BRIDGE, WC_BUILD_TOOLBAR, |