Mercurial > hg > openttd
changeset 12193:649406fd0b87 draft
(svn r16606) -Doc: Added/fixed doxygen comments.
| author | alberth <alberth@openttd.org> |
|---|---|
| date | Sat, 20 Jun 2009 15:48:55 +0000 |
| parents | 8d5108aed6b0 |
| children | bc18886c8d63 |
| files | src/autoreplace_gui.cpp src/gfx_func.h src/gfx_type.h |
| diffstat | 3 files changed, 14 insertions(+), 7 deletions(-) [+] |
line wrap: on
line diff
--- a/src/autoreplace_gui.cpp +++ b/src/autoreplace_gui.cpp @@ -105,11 +105,11 @@ GroupID sel_group; static RailType sel_railtype; - /** Figure out if an engine should be added to a list - * @param e The EngineID - * @param draw_left If true, then the left list is drawn (the engines specific to the railtype you selected) - * @param show_engines if truem then locomotives are drawn, else wagons (never both) - * @return true if the engine should be in the list (based on this check) + /** Figure out if an engine should be added to a list. + * @param e The EngineID. + * @param draw_left If \c true, the the left list is drawn (the engines specific to the railtype you selected). + * @param show_engines If \c true, the locomotives are drawn, else the wagons are drawn (never both). + * @return \c true if the engine should be in the list (based on this check), else \c false. */ bool GenerateReplaceRailList(EngineID e, bool draw_left, bool show_engines) {
--- a/src/gfx_func.h +++ b/src/gfx_func.h @@ -146,7 +146,7 @@ bool ToggleFullScreen(bool fs); /* gfx.cpp */ -extern FontSize _cur_fontsize; +extern FontSize _cur_fontsize; ///< Currently selected font. byte GetCharacterWidth(FontSize size, uint32 key); @@ -162,8 +162,13 @@ return _font_height[size]; } +/** Height of characters in the small (#FS_SMALL) font. */ #define FONT_HEIGHT_SMALL (GetCharacterHeight(FS_SMALL)) + +/** Height of characters in the normal (#FS_NORMAL) font. */ #define FONT_HEIGHT_NORMAL (GetCharacterHeight(FS_NORMAL)) + +/** Height of characters in the large (#FS_LARGE) font. */ #define FONT_HEIGHT_LARGE (GetCharacterHeight(FS_LARGE)) extern DrawPixelInfo *_cur_dpi;
--- a/src/gfx_type.h +++ b/src/gfx_type.h @@ -129,6 +129,7 @@ bool vehchain; ///< vehicle chain is dragged }; +/** Data about how and where to blit pixels. */ struct DrawPixelInfo { void *dst_ptr; int left, top, width, height; @@ -136,6 +137,7 @@ ZoomLevel zoom; }; +/** Structure to access the alpha, red, green, and blue channels from a 32 bit number. */ struct Colour { #if TTD_ENDIAN == TTD_BIG_ENDIAN uint8 a, r, g, b; ///< colour channels in BE order @@ -143,7 +145,7 @@ uint8 b, g, r, a; ///< colour channels in LE order #endif /* TTD_ENDIAN == TTD_BIG_ENDIAN */ - operator uint32 () const { return *(uint32 *)this; } + operator uint32 () const { return *(uint32 *)this; } ///< Conversion of the channel information to a 32 bit number. }; /** Available font sizes */