X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=simgear%2Fio%2Fsg_file.hxx;h=f029763338d9e8fad576bd3b63552ba3e2b1baf9;hb=dc09a50472890ac706d3c76d8af34cc3682ada0c;hp=a0c35e6cd48a490733421e9f034d1a475636f038;hpb=c16b9ed25b9c8d7229153787aa1492e4ea37b61e;p=simgear.git

diff --git a/simgear/io/sg_file.hxx b/simgear/io/sg_file.hxx
index a0c35e6c..f0297633 100644
--- a/simgear/io/sg_file.hxx
+++ b/simgear/io/sg_file.hxx
@@ -1,8 +1,10 @@
-// sg_file.hxx -- File I/O routines
-//
+/** \file sg_file.hxx
+ * File I/O routines.
+ */
+
 // Written by Curtis Olson, started November 1999.
 //
-// Copyright (C) 1999  Curtis L. Olson - curt@flightgear.org
+// Copyright (C) 1999  Curtis L. Olson - http://www.flightgear.org/~curt
 //
 // This program is free software; you can redistribute it and/or
 // modify it under the terms of the GNU General Public License as
@@ -45,6 +47,9 @@
 SG_USING_STD(string);
 
 
+/**
+ * A file I/O class based on SGIOChannel.
+ */
 class SGFile : public SGIOChannel {
 
     string file_name;
@@ -52,7 +57,16 @@ class SGFile : public SGIOChannel {
 
 public:
 
+    /**
+     * Create an instance of SGFile.
+     * When calling the constructor you need to provide a file
+     * name. This file is not opened immediately, but instead will be
+     * opened when the open() method is called.
+     * @param file name of file to open
+     */
     SGFile( const string& file );
+
+    /** Destructor */
     ~SGFile();
 
     // open the file based on specified direction
@@ -73,6 +87,7 @@ public:
     // close file
     bool close();
 
+    /** @return the name of the file being manipulated. */
     inline string get_file_name() const { return file_name; }
 };