mirror/OpenTTD
1
0
Fork 1
mirror of https://github.com/OpenTTD/OpenTTD.git synced 2025-09-02 03:19:10 +00:00
Code Issues Activity

Doc: Lots and lots of doxymentation fixes

Browse Source
This commit is contained in:
Charles Pigott
2018-10-28 02:17:36 +00:00
committed by frosch
parent b9273cbe07
commit f5b1115039
108 changed files with 265 additions and 290 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/widget.cpp
View File

@@ -755,7 +755,7 @@ NWidgetBase::NWidgetBase(WidgetType tp) : ZeroedMemoryAllocator()
*/
/**
* @fn void FillNestedArray(NWidgetBase **array, uint length)
* @fn void NWidgetBase::FillNestedArray(NWidgetBase **array, uint length)
* Fill the Window::nested_array array with pointers to nested widgets in the tree.
* @param array Base pointer of the array.
* @param length Length of the array.
@@ -1673,10 +1673,10 @@ NWidgetCore *NWidgetMatrix::GetWidgetFromPos(int x, int y)
/**
* Get the different offsets that are influenced by scrolling.
* @param [out] start_x The start position in columns (index of the left-most column, swapped in RTL).
* @param [out] start_y The start position in rows.
* @param [out] base_offs_x The base horizontal offset in pixels (X position of the column \a start_x).
* @param [out] base_offs_y The base vertical offset in pixels (Y position of the column \a start_y).
* @param[out] start_x The start position in columns (index of the left-most column, swapped in RTL).
* @param[out] start_y The start position in rows.
* @param[out] base_offs_x The base horizontal offset in pixels (X position of the column \a start_x).
* @param[out] base_offs_y The base vertical offset in pixels (Y position of the column \a start_y).
*/
void NWidgetMatrix::GetScrollOffsets(int &start_x, int &start_y, int &base_offs_x, int &base_offs_y)
{
@@ -2805,7 +2805,7 @@ NWidgetContainer *MakeNWidgets(const NWidgetPart *parts, int count, int *biggest
* @param parts Array with parts of the widgets.
* @param count Length of the \a parts array.
* @param biggest_index Pointer to biggest nested widget index collected in the tree.
* @param [out] shade_select Pointer to the inserted shade selection widget (\c NULL if not unserted).
* @param[out] shade_select Pointer to the inserted shade selection widget (\c NULL if not unserted).
* @return Root of the nested widget tree, a vertical container containing the entire GUI.
* @ingroup NestedWidgetParts
* @pre \c biggest_index != NULL