(svn r20283) -Codechange: Unify start of doygen comments.

This commit is contained in:
frosch
2010-08-01 19:22:34 +00:00
parent 4871baf44d
commit ed4f806f1d
162 changed files with 1304 additions and 652 deletions

View File

@@ -721,7 +721,8 @@ const StringID CompanyStationsWindow::sorter_names[] = {
INVALID_STRING_ID
};
/** Make a horizontal row of cargo buttons, starting at widget #SLW_CARGOSTART.
/**
* Make a horizontal row of cargo buttons, starting at widget #SLW_CARGOSTART.
* @param biggest_index Pointer to store biggest used widget number of the buttons.
* @return Horizontal row.
*/
@@ -976,7 +977,8 @@ struct StationViewWindow : public Window {
}
}
/** Order waiting cargo by type and destination.
/**
* Order waiting cargo by type and destination.
* @param cargolist [out] Ordered cargo.
* @param transfers [out] Bitmask for cargoes being transfered.
* @pre \c *cargolist must be empty.
@@ -1030,7 +1032,8 @@ struct StationViewWindow : public Window {
}
}
/** Draw waiting cargo.
/**
* Draw waiting cargo.
* @param r Rectangle of the widget.
* @param cargolist Cargo, ordered by type and destination.
* @param transfers Bitmask for cargoes that are transfered.
@@ -1087,7 +1090,8 @@ struct StationViewWindow : public Window {
}
}
/** Draw accepted cargo in the #SVW_ACCEPTLIST widget.
/**
* Draw accepted cargo in the #SVW_ACCEPTLIST widget.
* @param r Rectangle of the widget.
* @return Number of lines needed for drawing the accepted cargo.
*/
@@ -1104,7 +1108,8 @@ struct StationViewWindow : public Window {
return CeilDiv(bottom - r.top - WD_FRAMERECT_TOP, FONT_HEIGHT_NORMAL);
}
/** Draw cargo ratings in the #SVW_ACCEPTLIST widget.
/**
* Draw cargo ratings in the #SVW_ACCEPTLIST widget.
* @param r Rectangle of the widget.
* @return Number of lines needed for drawing the cargo ratings.
*/