(svn r12693) -Documentation: add some documentation to some window related stuff. Based on a patch by Albert.
authorrubidium
Sun, 13 Apr 2008 19:01:26 +0000
changeset 10162 d0d33ae1c7bc
parent 10161 4331e1c4c987
child 10163 d18ad4693602
(svn r12693) -Documentation: add some documentation to some window related stuff. Based on a patch by Albert.
src/window.cpp
src/window_gui.h
src/window_type.h
--- a/src/window.cpp	Sun Apr 13 18:59:32 2008 +0000
+++ b/src/window.cpp	Sun Apr 13 19:01:26 2008 +0000
@@ -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 @@
 	return NULL;
 }
 
+/**
+ * (re)initialize the windowing system
+ */
 void InitWindowSystem()
 {
 	IConsoleClose();
@@ -1057,6 +1059,9 @@
 	_no_scroll = 0;
 }
 
+/**
+ * Close down the windowing system
+ */
 void UnInitWindowSystem()
 {
 	Window **wz;
@@ -1075,6 +1080,9 @@
 	assert(_last_z_window == _z_windows);
 }
 
+/**
+ * Reset the windowing system, by means of shutting it down followed by re-initialization
+ */
 void ResetWindowSystem()
 {
 	UnInitWindowSystem();
--- a/src/window_gui.h	Sun Apr 13 18:59:32 2008 +0000
+++ b/src/window_gui.h	Sun Apr 13 19:01:26 2008 +0000
@@ -307,7 +307,7 @@
 	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
--- a/src/window_type.h	Sun Apr 13 18:59:32 2008 +0000
+++ b/src/window_type.h	Sun Apr 13 19:01:26 2008 +0000
@@ -7,6 +7,9 @@
 
 #include "core/enum_type.hpp"
 
+/**
+ * Window classes
+ */
 enum WindowClass {
 	WC_NONE,
 	WC_MAIN_WINDOW = WC_NONE,