petern/OpenTTD
1
0
Fork 0
forked from mirror/OpenTTD
Code Pull Requests Activity

(svn r9662) -Documentation: Doxygen corrections and @file omissions

Browse Source
This commit is contained in:
belugas
2007-04-17 20:23:13 +00:00
parent c39ab93daa
commit 607a55f4ec
31 changed files with 122 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/news_gui.cpp
View File

@@ -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