diff options
| author | belugas <belugas@openttd.org> | 2007-04-17 20:23:13 +0000 |
|---|---|---|
| committer | belugas <belugas@openttd.org> | 2007-04-17 20:23:13 +0000 |
| commit | 607a55f4ec509649d3799df9dff54a28d074e693 (patch) | |
| tree | b4ba94aa4f1173fcc27e954fd5d4ed6561876881 /src/news_gui.cpp | |
| parent | c39ab93daa5af53272b108a628ed2e857b95fb64 (diff) | |
| download | openttd-607a55f4ec509649d3799df9dff54a28d074e693.tar.xz | |
(svn r9662) -Documentation: Doxygen corrections and @file omissions
Diffstat (limited to 'src/news_gui.cpp')
| -rw-r--r-- | src/news_gui.cpp | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/src/news_gui.cpp b/src/news_gui.cpp index a94461180..0bfb21b4c 100644 --- a/src/news_gui.cpp +++ b/src/news_gui.cpp @@ -240,17 +240,17 @@ static inline NewsID decreaseIndex(NewsID i) * @param flags various control bits that will show various news-types. See macro NEWS_FLAGS() * @param data_a news-specific value based on news type * @param data_b news-specific value based on news type - * @note flags exists of 4 byte-sized extra parameters.<br/> - * 1. 0 - 7 display_mode, any of the NewsMode enums (NM_)<br/> - * 2. 8 - 15 news flags, any of the NewsFlags enums (NF_) NF_INCOLOR are set automatically if needed<br/> - * 3. 16 - 23 news category, any of the NewsType enums (NT_)<br/> - * 4. 24 - 31 news callback function, any of the NewsCallback enums (DNC_)<br/> + * @note flags exists of 4 byte-sized extra parameters. + * 1. 0 - 7 display_mode, any of the NewsMode enums (NM_) + * 2. 8 - 15 news flags, any of the NewsFlags enums (NF_) NF_INCOLOR are set automatically if needed + * 3. 16 - 23 news category, any of the NewsType enums (NT_) + * 4. 24 - 31 news callback function, any of the NewsCallback enums (DNC_) * If the display mode is NM_CALLBACK special news is shown and parameter - * stringid has a special meaning.<br/> + * stringid has a special meaning. * DNC_TRAINAVAIL, DNC_ROADAVAIL, DNC_SHIPAVAIL, DNC_AIRCRAFTAVAIL: StringID is - * the index of the engine that is shown<br/> + * the index of the engine that is shown * DNC_BANKRUPCY: bytes 0-3 of StringID contains the player that is in trouble, - * and 4-7 contains what kind of bankrupcy message is shown, NewsBankrupcy enum (NB_)<br/> + * and 4-7 contains what kind of bankrupcy message is shown, NewsBankrupcy enum (NB_) * @see NewsMode * @see NewsFlags * @see NewsType |