From 23105577167343a3379769af09b63413d643a277 Mon Sep 17 00:00:00 2001
From: rubidium <rubidium@openttd.org>
Date: Sun, 13 Apr 2008 19:01:26 +0000
Subject: (svn r12693) -Documentation: add some documentation to some window
 related stuff. Based on a patch by Albert.

---
 src/window.cpp    | 12 ++++++++++--
 src/window_gui.h  |  2 +-
 src/window_type.h |  3 +++
 3 files changed, 14 insertions(+), 3 deletions(-)

(limited to 'src')

diff --git a/src/window.cpp b/src/window.cpp
index 7fe896993..cd2dcfc6e 100644
--- a/src/window.cpp
+++ b/src/window.cpp
@@ -22,8 +22,7 @@
 
 #include "table/sprites.h"
 
-/** delta between mouse cursor and upper left corner of dragged window */
-static Point _drag_delta;
+static Point _drag_delta; //< delta between mouse cursor and upper left corner of dragged window
 
 static Window _windows[MAX_NUMBER_OF_WINDOWS];
 
@@ -1047,6 +1046,9 @@ Window *FindWindowFromPt(int x, int y)
 	return NULL;
 }
 
+/**
+ * (re)initialize the windowing system
+ */
 void InitWindowSystem()
 {
 	IConsoleClose();
@@ -1057,6 +1059,9 @@ void InitWindowSystem()
 	_no_scroll = 0;
 }
 
+/**
+ * Close down the windowing system
+ */
 void UnInitWindowSystem()
 {
 	Window **wz;
@@ -1075,6 +1080,9 @@ restart_search:
 	assert(_last_z_window == _z_windows);
 }
 
+/**
+ * Reset the windowing system, by means of shutting it down followed by re-initialization
+ */
 void ResetWindowSystem()
 {
 	UnInitWindowSystem();
diff --git a/src/window_gui.h b/src/window_gui.h
index dc28614b0..330a6f6e9 100644
--- a/src/window_gui.h
+++ b/src/window_gui.h
@@ -307,7 +307,7 @@ struct Window {
 	byte caption_color; ///< Background color of the window caption, contains PlayerID
 
 	WindowProc *wndproc;   ///< Event handler function for the window
-	ViewPort *viewport;    ///< Pointer to viewport, if present (structure is part of derived class)
+	ViewPort *viewport;    ///< Pointer to viewport, if present
 	const Widget *original_widget; ///< Original widget layout, copied from WindowDesc
 	Widget *widget;        ///< Widgets of the window
 	uint widget_count;     ///< Number of widgets of the window
diff --git a/src/window_type.h b/src/window_type.h
index f2630639c..7ae5ec9a8 100644
--- a/src/window_type.h
+++ b/src/window_type.h
@@ -7,6 +7,9 @@
 
 #include "core/enum_type.hpp"
 
+/**
+ * Window classes
+ */
 enum WindowClass {
 	WC_NONE,
 	WC_MAIN_WINDOW = WC_NONE,
-- 
cgit v1.2.3-70-g09d2