From 72eb1f100b944902bee8bcc092dfaf0acbdfdd56 Mon Sep 17 00:00:00 2001
From: rubidium <rubidium@openttd.org>
Date: Sun, 4 May 2008 08:38:21 +0000
Subject: (svn r12936) -Doc: a few structs in geometry_type.hpp. Patch by
 Alberth.

---
 src/core/geometry_type.hpp | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'src')

diff --git a/src/core/geometry_type.hpp b/src/core/geometry_type.hpp
index be89acdb7..6258ffd1d 100644
--- a/src/core/geometry_type.hpp
+++ b/src/core/geometry_type.hpp
@@ -17,16 +17,19 @@
 #endif /* __APPLE__ */
 
 
+/** Coordinates of a point in 2D */
 struct Point {
 	int x;
 	int y;
 };
 
+/** Dimensions (a width and height) of a rectangle in 2D */
 struct Dimension {
 	int width;
 	int height;
 };
 
+/** Specification of a rectangle with absolute coordinates of all edges */
 struct Rect {
 	int left;
 	int top;
@@ -34,6 +37,10 @@ struct Rect {
 	int bottom;
 };
 
+/**
+ * Specification of a rectangle with an absolute top-left coordinate and a
+ * (relative) width/height
+ */
 struct PointDimension {
 	int x;
 	int y;
@@ -41,6 +48,7 @@ struct PointDimension {
 	int height;
 };
 
+/** A pair of two integers */
 struct Pair {
 	int a;
 	int b;
-- 
cgit v1.2.3-70-g09d2