(svn r21886) -Codechange: move documentation towards the code to make it more likely to be updated [n].

1 files changed, 6 insertions, 0 deletions

diff --git a/src/news_gui.cpp b/src/news_gui.cpp
index 1a2997944..cf7b3e91b 100644
--- a/src/news_gui.cpp
+++ b/src/news_gui.cpp
@@ -754,6 +754,12 @@ static void DeleteNewsItem(NewsItem *ni)
 	SetWindowDirty(WC_MESSAGE_HISTORY, 0);
 }
 
+/**
+ * Delete a news item type about a vehicle.
+ * When the news item type is INVALID_STRING_ID all news about the vehicle gets deleted.
+ * @param vid  The vehicle to remove the news for.
+ * @param news The news type to remove.
+ */
 void DeleteVehicleNews(VehicleID vid, StringID news)
 {
 	NewsItem *ni = _oldest_news;