Updated to match changes in radiostack.[ch]xx

[flightgear.git] / src / FDM / JSBSim / FGConfigFile.h

diff --git a/src/FDM/JSBSim/FGConfigFile.h b/src/FDM/JSBSim/FGConfigFile.h
index 258f65cad62d88edfa9728d537aea735baef40c6..ffcb29fb2a23dd439254d32ab5c4e11444c44eb1 100644 (file)
--- a/src/FDM/JSBSim/FGConfigFile.h
+++ b/src/FDM/JSBSim/FGConfigFile.h
@@ -96,7 +96,10 @@ CLASS DOCUMENTATION
     JSBSim config files are in XML format.
     @author Jon S. Berndt
     @version $Id$
-    @see -
+    @see <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/jsbsim/JSBSim/FGConfigFile.h?rev=HEAD&content-type=text/vnd.viewcvs-markup">
+         Header File </a>
+    @see <a href="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/jsbsim/JSBSim/FGConfigFile.cpp?rev=HEAD&content-type=text/vnd.viewcvs-markup">
+         Source File </a>
 */
 
 /*%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -112,14 +115,20 @@ public:
   /// Destructor
   ~FGConfigFile();
 
-  string GetLine(void);
+  /** Returns the next line from the currently open config file.
+      Comments are bypassed and ignored.
+      @return the next valid line from the config file OR "EOF" if end of file is
+      reached.*/
   string GetNextConfigLine(void);
+
+  /** Returns the value of the tag supplied.
+      @param 
+      @return */
   string GetValue(string);
   string GetValue(void);
   string GetCommentString(void) {return CommentString;}
   string GetLineComment(void) {return LineComment;}
   bool IsOpen(void) {return Opened;}
-//  FGConfigFile& operator>>(double&);
   FGConfigFile& operator>>(double&);
   FGConfigFile& operator>>(int&);
   FGConfigFile& operator>>(string&);
@@ -133,8 +142,10 @@ private:
   string   LineComment;
   bool     CommentsOn;
   bool     Opened;
-  unsigned int      CurrentIndex;
-  void Debug(void);
+  unsigned int CurrentIndex;
+  string GetLine(void);
+
+  void Debug(int from);
 };
 
 //%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%