From 65f9a0f21a1379107683f7b5f2fc0c82f22a4cb6 Mon Sep 17 00:00:00 2001
From: rubidium <rubidium@openttd.org>
Date: Sun, 9 Sep 2007 10:13:17 +0000
Subject: (svn r11065) -Documentation [FS#1186]: of the dirty
 marking/repainting subsystem. Patch by Progman.

---
 src/texteff.cpp | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

(limited to 'src/texteff.cpp')

diff --git a/src/texteff.cpp b/src/texteff.cpp
index e754a2f28..2bdd05c3d 100644
--- a/src/texteff.cpp
+++ b/src/texteff.cpp
@@ -256,7 +256,15 @@ void DrawChatMessage()
 	_chatmessage_dirty = false;
 }
 
-/** Text Effects */
+/* Text Effects */
+/**
+ * Mark the area of the text effect as dirty.
+ *
+ * This function marks the area of a text effect as dirty for repaint.
+ *
+ * @param te The TextEffect to mark the area dirty
+ * @ingroup dirty
+ */
 static void MarkTextEffectAreaDirty(TextEffect *te)
 {
 	/* Width and height of the text effect are doubled, so they are correct in both zoom out levels 1x and 2x. */
-- 
cgit v1.2.3-54-g00ecf