Modified Files:

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

diff --git a/simgear/math/sg_types.hxx b/simgear/math/sg_types.hxx
index a0d89029421a67f019d64c7d8b109dfc40d1d736..0ffa2b76ba2fb155b32ff78eb9508192a2cbd405 100644 (file)
--- a/simgear/math/sg_types.hxx
+++ b/simgear/math/sg_types.hxx
@@ -1,8 +1,11 @@
-// 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
+// Copyright (C) 1999  Curtis L. Olson  - http://www.flightgear.org/~curt
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Library General Public
@@ -14,21 +17,20 @@
 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 // Library General Public License for more details.
 //
-// You should have received a copy of the GNU Library General Public
-// License along with this library; if not, write to the
-// Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-// Boston, MA  02111-1307, USA.
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the Free Software
+// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 //
 // $Id$
 
 
-#ifndef _FG_TYPES_HXX
-#define _FG_TYPES_HXX
+#ifndef _SG_TYPES_HXX
+#define _SG_TYPES_HXX
 
 
-#ifndef __cplusplus                                                          
+#ifndef __cplusplus
 # error This library requires C++
-#endif                                   
+#endif
 
 
 #include <simgear/compiler.h>
@@ -38,23 +40,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 +83,5 @@ public:
 };
 
 
-#endif // _FG_TYPES_HXX
+#endif // _SG_TYPES_HXX