From 8ff93c2c1468e387ef467aaf099ade3f980daa00 Mon Sep 17 00:00:00 2001
From: rubidium <rubidium@openttd.org>
Date: Sat, 3 Jan 2009 10:52:22 +0000
Subject: (svn r14794) -Document: a few functions/variables (Alberth)

---
 src/settings_gui.cpp |  2 +-
 src/window.cpp       | 21 +++++++++++++++++++++
 2 files changed, 22 insertions(+), 1 deletion(-)

(limited to 'src')

diff --git a/src/settings_gui.cpp b/src/settings_gui.cpp
index 014a171e9..2506cd206 100644
--- a/src/settings_gui.cpp
+++ b/src/settings_gui.cpp
@@ -750,7 +750,7 @@ enum PatchesSelectionWidgets {
 };
 
 struct PatchesSelectionWindow : Window {
-	static GameSettings *patches_ptr;
+	static GameSettings *patches_ptr;  ///< Pointer to the game settings being displayed and modified
 	static int patches_max;  ///< Maximal number of patches on a single page
 
 	int page;
diff --git a/src/window.cpp b/src/window.cpp
index c0911561c..00b81c1d4 100644
--- a/src/window.cpp
+++ b/src/window.cpp
@@ -2236,6 +2236,13 @@ int PositionMainToolbar(Window *w)
 	return w->left;
 }
 
+/**
+ * Set the number of items of the vertical scrollbar.
+ *
+ * Function also updates the position of the scrollbar if necessary.
+ * @param w   Window containing the vertical scrollbar
+ * @param num New number of items
+ */
 void SetVScrollCount(Window *w, int num)
 {
 	w->vscroll.count = num;
@@ -2244,6 +2251,13 @@ void SetVScrollCount(Window *w, int num)
 	if (num < w->vscroll.pos) w->vscroll.pos = num;
 }
 
+/**
+ * Set the number of items of the second vertical scrollbar.
+ *
+ * Function also updates the position of the scrollbar if necessary.
+ * @param w   Window containing the second vertical scrollbar
+ * @param num New number of items
+ */
 void SetVScroll2Count(Window *w, int num)
 {
 	w->vscroll2.count = num;
@@ -2252,6 +2266,13 @@ void SetVScroll2Count(Window *w, int num)
 	if (num < w->vscroll2.pos) w->vscroll2.pos = num;
 }
 
+/**
+ * Set the number of items of the horizontal scrollbar.
+ *
+ * Function also updates the position of the scrollbar if necessary.
+ * @param w   Window containing the horizontal scrollbar
+ * @param num New number of items
+ */
 void SetHScrollCount(Window *w, int num)
 {
 	w->hscroll.count = num;
-- 
cgit v1.2.3-54-g00ecf