]> git.mxchange.org Git - simgear.git/blobdiff - simgear/misc/strutils.hxx
Updates to build system to better support automake-1.5
[simgear.git] / simgear / misc / strutils.hxx
index 4b116d8b40ad41fa0c4a1208850e6945324187c3..1288f7dedbab344da1c40428524786b3a7ccdd7c 100644 (file)
@@ -1,25 +1,30 @@
-// String utilities.
-//
+/**
+ * \file strutils.hxx
+ * String utilities.
+ */
+
 // Written by Bernie Bright, 1998
 //
 // Copyright (C) 1998  Bernie Bright - bbright@c031.aone.net.au
 //
-// This program is free software; you can redistribute it and/or
-// modify it under the terms of the GNU General Public License as
-// published by the Free Software Foundation; either version 2 of the
-// License, or (at your option) any later version.
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Library General Public
+// License as published by the Free Software Foundation; either
+// version 2 of the License, or (at your option) any later version.
 //
-// This program is distributed in the hope that it will be useful, but
-// WITHOUT ANY WARRANTY; without even the implied warranty of
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-// General Public License for more details.
+// Library General Public License for more details.
 //
-// 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., 675 Mass Ave, Cambridge, MA 02139, USA.
+// 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.
 //
 // $Id$
 
+
 #ifndef STRUTILS_H
 #define STRUTILS_H
 
 
 #include STL_STRING
 
-#ifdef FG_HAVE_STD_INCLUDES
+#ifdef SG_HAVE_STD_INCLUDES
 #  include <cstdlib>
 #else
 #  include <stdlib.h>
 #endif
 
-FG_USING_STD(string);
+SG_USING_STD(string);
 
-// Default characters to remove.
+
+/** Default characters to remove. */
 extern const string whitespace;
 
-// Returns a string with trailing characters removed.
+/** Returns a string with trailing characters removed. */
 string trimleft( const string& s, const string& trimmings = whitespace );
 
-// Returns a string with leading characters removed.
+/** Returns a string with leading characters removed. */
 string trimright( const string& s, const string& trimmings = whitespace );
 
-// Returns a string with leading and trailing characters removed.
+/** Returns a string with leading and trailing characters removed. */
 string trim( const string& s, const string& trimmings = whitespace );
 
-//-----------------------------------------------------------------------------
-
+/** atof() wrapper for "string" type */
 inline double
 atof( const string& str )
 {
     return ::atof( str.c_str() );
 }
 
+/** atoi() wrapper for "string" type */
 inline int
 atoi( const string& str )
 {