summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrubidium <rubidium@openttd.org>2008-05-15 20:53:44 +0000
committerrubidium <rubidium@openttd.org>2008-05-15 20:53:44 +0000
commit9e4d664a247748d4bfc10a4bea74da0c80f83313 (patch)
tree468982233cf1961c7b54a361eb12b0519b44bc2b
parentc81a333cb60dfda9e3fa35db1fa19e35b638299c (diff)
downloadopenttd-9e4d664a247748d4bfc10a4bea74da0c80f83313.tar.xz
(svn r13111) -Documentation: update the documentation of AddNewsItem to reflect reality. Patch by Cirdan.
-rw-r--r--src/news_gui.cpp21
1 files changed, 3 insertions, 18 deletions
diff --git a/src/news_gui.cpp b/src/news_gui.cpp
index 9e8a85bdc..5fd782cfe 100644
--- a/src/news_gui.cpp
+++ b/src/news_gui.cpp
@@ -298,27 +298,12 @@ static inline NewsID DecreaseIndex(NewsID i)
/**
* Add a new newsitem to be shown.
- * @param string String to display, can have special values based on parameter \a display_mode
- * @param display_mode, any of the NewsMode enums (NM_)
- * @param flags any of the NewsFlag enums (NF_)
- * @param type news category, any of the NewsType enums (NT_)
- * @param callback news callback function, any of the NewsCallback enums (DNC_)
+ * @param string String to display
+ * @param subtype news category, any of the NewsSubtype enums (NS_)
* @param data_a news-specific value based on news type
* @param data_b news-specific value based on news type
*
- * @note If the display mode is NM_CALLBACK, special news is shown and parameter
- * \a string has a special meaning.
- * - For DNC_TRAINAVAIL, DNC_ROADAVAIL, DNC_SHIPAVAIL, DNC_AIRCRAFTAVAIL messages: StringID is
- * the index of the engine that is shown
- *
- * - For 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.
- * @see NewsBankrupcy
- *
- * @see NewsMode
- * @see NewsFlag
- * @see NewsType
- * @see NewsCallback
+ * @see NewsSubype
*/
void AddNewsItem(StringID string, NewsSubtype subtype, uint data_a, uint data_b)
{