mirror of https://github.com/OpenTTD/OpenTTD.git
(svn r18490) -Doc: Fixed syntax of a few doxygen pre and post coditions.
This commit is contained in:
parent
7c4eaf73a7
commit
57e6c7fdb7
|
@ -107,7 +107,7 @@ struct GraphLegendWindow : Window {
|
|||
* Construct a vertical list of buttons, one for each company.
|
||||
* @param biggest_index Storage for collecting the biggest index used in the returned tree.
|
||||
* @return Panel with company buttons.
|
||||
* @postcond \c *biggest_index contains the largest used index in the tree.
|
||||
* @post \c *biggest_index contains the largest used index in the tree.
|
||||
*/
|
||||
static NWidgetBase *MakeNWidgetCompanyLines(int *biggest_index)
|
||||
{
|
||||
|
@ -1375,7 +1375,7 @@ CompanyID PerformanceRatingDetailWindow::company = INVALID_COMPANY;
|
|||
/** Make a vertical list of panels for outputting score details.
|
||||
* @param biggest_index Storage for collecting the biggest index used in the returned tree.
|
||||
* @return Panel with performance details.
|
||||
* @postcond \c *biggest_index contains the largest used index in the tree.
|
||||
* @post \c *biggest_index contains the largest used index in the tree.
|
||||
*/
|
||||
static NWidgetBase *MakePerformanceDetailPanels(int *biggest_index)
|
||||
{
|
||||
|
@ -1409,7 +1409,7 @@ static NWidgetBase *MakePerformanceDetailPanels(int *biggest_index)
|
|||
* Make a number of rows with button-like graphics, for enabling/disabling each company.
|
||||
* @param biggest_index Storage for collecting the biggest index used in the returned tree.
|
||||
* @return Panel with rows of company buttons.
|
||||
* @postcond \c *biggest_index contains the largest used index in the tree.
|
||||
* @post \c *biggest_index contains the largest used index in the tree.
|
||||
*/
|
||||
static NWidgetBase *MakeCompanyButtonRows(int *biggest_index)
|
||||
{
|
||||
|
|
|
@ -2089,7 +2089,7 @@ bool NWidgetLeaf::ButtonHit(const Point &pt)
|
|||
* @param fill_dest Fill the composed widget with child widgets.
|
||||
* @param biggest_index Pointer to biggest nested widget index in the tree encountered so far.
|
||||
* @return Number of widget part elements used to compose the widget.
|
||||
* @precond \c biggest_index != NULL.
|
||||
* @pre \c biggest_index != NULL.
|
||||
*/
|
||||
static int MakeNWidget(const NWidgetPart *parts, int count, NWidgetBase **dest, bool *fill_dest, int *biggest_index)
|
||||
{
|
||||
|
@ -2237,7 +2237,7 @@ static int MakeNWidget(const NWidgetPart *parts, int count, NWidgetBase **dest,
|
|||
* @param parent Container to use for storing the child widgets.
|
||||
* @param biggest_index Pointer to biggest nested widget index in the tree.
|
||||
* @return Number of widget part elements used to fill the container.
|
||||
* @postcond \c *biggest_index contains the largest widget index of the tree and \c -1 if no index is used.
|
||||
* @post \c *biggest_index contains the largest widget index of the tree and \c -1 if no index is used.
|
||||
*/
|
||||
static int MakeWidgetTree(const NWidgetPart *parts, int count, NWidgetBase *parent, int *biggest_index)
|
||||
{
|
||||
|
|
|
@ -557,7 +557,7 @@ struct NWidgetPartTextLines {
|
|||
/** Pointer to function returning a nested widget.
|
||||
* @param biggest_index Pointer to storage for collecting the biggest index used in the nested widget.
|
||||
* @return Nested widget (tree).
|
||||
* @postcond \c *biggest_index must contain the value of the biggest index in the returned tree.
|
||||
* @post \c *biggest_index must contain the value of the biggest index in the returned tree.
|
||||
*/
|
||||
typedef NWidgetBase *NWidgetFunctionType(int *biggest_index);
|
||||
|
||||
|
|
Loading…
Reference in New Issue