cygwin and mingw fixes

[simgear.git] / simgear / math / sg_types.hxx

diff --git a/simgear/math/sg_types.hxx b/simgear/math/sg_types.hxx
index a0d89029421a67f019d64c7d8b109dfc40d1d736..0a3454a48bbba948027dd3b4ed6f18804c3db307 100644 (file)
--- a/simgear/math/sg_types.hxx
+++ b/simgear/math/sg_types.hxx
@@ -1,5 +1,8 @@
-// fg_types.hxx -- commonly used types I don't want to have to keep redefining
-//
+/**
+ * \file sg_types.hxx
+ * Commonly used types I don't want to have to keep redefining.
+ */
+
 // Written by Curtis Olson, started March 1999.
 //
 // Copyright (C) 1999  Curtis L. Olson  - curt@flightgear.org
@@ -22,8 +25,8 @@
 // $Id$
 
 
-#ifndef _FG_TYPES_HXX
-#define _FG_TYPES_HXX
+#ifndef _SG_TYPES_HXX
+#define _SG_TYPES_HXX
 
 
 #ifndef __cplusplus                                                          
@@ -38,23 +41,34 @@
 
 #include <simgear/math/point3d.hxx>
 
-FG_USING_STD(vector);
-FG_USING_STD(string);
-
+SG_USING_STD(vector);
+SG_USING_STD(string);
 
+/** STL vector list of ints */
 typedef vector < int > int_list;
 typedef int_list::iterator int_list_iterator;
 typedef int_list::const_iterator const_int_list_iterator;
 
+/** STL vector list of doubles */
+typedef vector < double > double_list;
+typedef double_list::iterator double_list_iterator;
+typedef double_list::const_iterator const_double_list_iterator;
+
+/** STL vector list of Point3D */
 typedef vector < Point3D > point_list;
 typedef point_list::iterator point_list_iterator;
 typedef point_list::const_iterator const_point_list_iterator;
 
+/** STL vector list of strings */
 typedef vector < string > string_list;
 typedef string_list::iterator string_list_iterator;
 typedef string_list::const_iterator const_string_list_iterator;
 
 
+/**
+ * Simple 2d point class where members can be accessed as x, dist, or lon
+ * and y, theta, or lat
+ */
 class point2d {
 public:
     union {
@@ -70,5 +84,5 @@ public:
 };
 
 
-#endif // _FG_TYPES_HXX
+#endif // _SG_TYPES_HXX