summaryrefslogtreecommitdiff
path: root/src/gfx.cpp
diff options
context:
space:
mode:
authorrubidium <rubidium@openttd.org>2011-01-18 22:31:06 +0000
committerrubidium <rubidium@openttd.org>2011-01-18 22:31:06 +0000
commit7efd7e19ed046a4a0c03077f27930291ba5b9725 (patch)
tree9e08703cd992ede72e5165044b69750b1385510f /src/gfx.cpp
parent6c9078fd30097b38537a60fbecb9828da69c3517 (diff)
downloadopenttd-7efd7e19ed046a4a0c03077f27930291ba5b9725.tar.xz
(svn r21845) -Codechange: move documentation towards the code to make it more likely to be updates [d-m].
Diffstat (limited to 'src/gfx.cpp')
-rw-r--r--src/gfx.cpp7
1 files changed, 4 insertions, 3 deletions
diff --git a/src/gfx.cpp b/src/gfx.cpp
index 410ea6686..7fad4f15b 100644
--- a/src/gfx.cpp
+++ b/src/gfx.cpp
@@ -1559,7 +1559,7 @@ void RedrawScreenRect(int left, int top, int right, int bottom)
_video_driver->MakeDirty(left, top, right - left, bottom - top);
}
-/*!
+/**
* Repaints the rectangle blocks which are marked as 'dirty'.
*
* @see SetDirtyBlocks
@@ -1653,7 +1653,7 @@ void DrawDirtyBlocks()
_invalid_rect.bottom = 0;
}
-/*!
+/**
* This function extends the internal _invalid_rect rectangle as it
* now contains the rectangle defined by the given parameters. Note
* the point (0,0) is top left.
@@ -1705,10 +1705,11 @@ void SetDirtyBlocks(int left, int top, int right, int bottom)
} while (--height != 0);
}
-/*!
+/**
* This function mark the whole screen as dirty. This results in repainting
* the whole screen. Use this with care as this function will break the
* idea about marking only parts of the screen as 'dirty'.
+ * @ingroup dirty
*/
void MarkWholeScreenDirty()
{