summaryrefslogtreecommitdiff
path: root/src/news_type.h
diff options
context:
space:
mode:
authorrubidium <rubidium@openttd.org>2011-05-02 16:14:23 +0000
committerrubidium <rubidium@openttd.org>2011-05-02 16:14:23 +0000
commit4d5dbf51707c42c24eeafdb65016b079c54adcf2 (patch)
tree0197dcc17f4a8411ecea2223f356019c902fe7b9 /src/news_type.h
parente9837ff1ec1326aec622366ae29ff1aa81581daf (diff)
downloadopenttd-4d5dbf51707c42c24eeafdb65016b079c54adcf2.tar.xz
(svn r22410) -Document: some more bits ;)
Diffstat (limited to 'src/news_type.h')
-rw-r--r--src/news_type.h10
1 files changed, 9 insertions, 1 deletions
diff --git a/src/news_type.h b/src/news_type.h
index f179f5551..edb475d40 100644
--- a/src/news_type.h
+++ b/src/news_type.h
@@ -119,6 +119,13 @@ struct NewsTypeData {
NewsDisplay display; ///< Display mode (off, summary, full)
const StringID description; ///< Description of the news type in news settings window
+ /**
+ * Construct this entry.
+ * @param name The name of the type.
+ * @param age The maximum age for these messages.
+ * @param sound The sound to play.
+ * @param description The description for this type of messages.
+ */
NewsTypeData(const char *name, byte age, SoundFx sound, StringID description) :
name(name),
age(age),
@@ -129,6 +136,7 @@ struct NewsTypeData {
}
};
+/** Information about a single item of news. */
struct NewsItem {
NewsItem *prev; ///< Previous news item
NewsItem *next; ///< Next news item
@@ -149,7 +157,7 @@ struct NewsItem {
free(this->free_data);
}
- uint64 params[10];
+ uint64 params[10]; ///< Parameters for string resolving.
};
/**