X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=simgear%2Fmisc%2Fstrutils.hxx;h=1288f7dedbab344da1c40428524786b3a7ccdd7c;hb=5bab565cfe4c30d6cf08ecaba50af74d5e4f0c98;hp=baf19f8bd7578cad7d3b40a81ab14f853ee46a9f;hpb=c16b9ed25b9c8d7229153787aa1492e4ea37b61e;p=simgear.git

diff --git a/simgear/misc/strutils.hxx b/simgear/misc/strutils.hxx
index baf19f8b..1288f7de 100644
--- a/simgear/misc/strutils.hxx
+++ b/simgear/misc/strutils.hxx
@@ -1,5 +1,8 @@
-// String utilities.
-//
+/**
+ * \file strutils.hxx
+ * String utilities.
+ */
+
 // Written by Bernie Bright, 1998
 //
 // Copyright (C) 1998  Bernie Bright - bbright@c031.aone.net.au
@@ -21,6 +24,7 @@
 //
 // $Id$
 
+
 #ifndef STRUTILS_H
 #define STRUTILS_H
 
@@ -36,26 +40,27 @@
 
 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 )
 {