mirror
/
OpenTTD
mirror of https://github.com/OpenTTD/OpenTTD
1
0
Fork 0
Code Issues

(svn r18492) -Doc: A few Doxygen reference fixes (NewsSubtype reported by Eddi), and a typo fix.

release/1.0
alberth 2009-12-13 21:12:36 +00:00
parent a8e9891f45
commit e0393a3de1
4 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/newgrf_text.cpp
View File

@ -91,7 +91,7 @@ StringID TTDPStringIDToOTTDStringIDMapping(StringID str)
} }
/** /**
* Explains the newgrf shift bit positionning. * Explains the newgrf shift bit positioning.
* the grf base will not be used in order to find the string, but rather for * the grf base will not be used in order to find the string, but rather for
* jumping from standard langID scheme to the new one. * jumping from standard langID scheme to the new one.
*/ */

2
src/news_gui.cpp
View File

@ -658,7 +658,7 @@ static void MoveToNextItem()
* @param ref2 Reference 2 to some object: Used for scrolling after clicking on the news, and for deleteing the news when the object is deleted. * @param ref2 Reference 2 to some object: Used for scrolling after clicking on the news, and for deleteing the news when the object is deleted.
* @param free_data Pointer to data that must be freed once the news message is cleared * @param free_data Pointer to data that must be freed once the news message is cleared
* *
* @see NewsSubype * @see NewsSubtype
*/ */
void AddNewsItem(StringID string, NewsSubtype subtype, NewsReferenceType reftype1, uint32 ref1, NewsReferenceType reftype2, uint32 ref2, void *free_data) void AddNewsItem(StringID string, NewsSubtype subtype, NewsReferenceType reftype1, uint32 ref1, NewsReferenceType reftype2, uint32 ref2, void *free_data)
{ {

2
src/widget.cpp
View File

@ -702,7 +702,7 @@ inline void NWidgetBase::StoreSizePosition(SizingType sizing, uint x, uint y, ui
} }
/** /**
* @fn void Draw(const Window *w) * @fn void NWidgetBase::Draw(const Window *w)
* Draw the widgets of the tree. * Draw the widgets of the tree.
* The function calls #Window::DrawWidget for each widget with a non-negative index, after the widget itself is painted. * The function calls #Window::DrawWidget for each widget with a non-negative index, after the widget itself is painted.
* @param w Window that owns the tree. * @param w Window that owns the tree.

6
src/widget_type.h
View File

@ -632,8 +632,8 @@ static inline NWidgetPart SetMinimalTextLines(uint8 lines, uint8 spacing, FontSi
/** /**
* Widget part function for setting filling. * Widget part function for setting filling.
* @param x_fill Allow horizontal filling from minimal size. * @param fill_x Horizontal filling step from minimal size.
* @param y_fill Allow vertical filling from minimal size. * @param fill_y Vertical filling step from minimal size.
* @ingroup NestedWidgetParts * @ingroup NestedWidgetParts
*/ */
static inline NWidgetPart SetFill(uint fill_x, uint fill_y) static inline NWidgetPart SetFill(uint fill_x, uint fill_y)
@ -750,7 +750,7 @@ static inline NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx = -1)
/** /**
* Widget part function for starting a new horizontal container, vertical container, or spacer widget. * Widget part function for starting a new horizontal container, vertical container, or spacer widget.
* @param tp Type of the new nested widget, #NWID_HORIZONTAL(_LTR), #NWID_VERTICAL, #NWID_SPACER, #NWID_SELECTION, or #NWID_LAYERED. * @param tp Type of the new nested widget, #NWID_HORIZONTAL(_LTR), #NWID_VERTICAL, #NWID_SPACER, or #NWID_SELECTION.
* @param cont_flags Flags for the containers (#NWID_HORIZONTAL(_LTR) and #NWID_VERTICAL). * @param cont_flags Flags for the containers (#NWID_HORIZONTAL(_LTR) and #NWID_VERTICAL).
* @ingroup NestedWidgetParts * @ingroup NestedWidgetParts
*/ */