1
0
mirror of https://github.com/OpenTTD/OpenTTD.git synced 2025-08-12 09:09:09 +00:00

(svn r21270) -Doc: Doxyment updates and additions. Removal of doxyment in code.

This commit is contained in:
alberth
2010-11-20 14:15:02 +00:00
parent 5d72befbcd
commit 3b0ee65571
9 changed files with 60 additions and 29 deletions

View File

@@ -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,