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

diff --git a/simgear/io/sg_file.hxx b/simgear/io/sg_file.hxx
index b2618f28..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
@@ -42,9 +44,12 @@
 
 #include "iochannel.hxx"
 
-FG_USING_STD(string);
+SG_USING_STD(string);
 
 
+/**
+ * A file I/O class based on SGIOChannel.
+ */
 class SGFile : public SGIOChannel {
 
     string file_name;
@@ -52,11 +57,20 @@ 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
-    bool open( SGProtocolDir dir );
+    bool open( const SGProtocolDir dir );
 
     // read a block of data of specified size
     int read( char *buf, int length );
@@ -65,14 +79,15 @@ public:
     int readline( char *buf, int length );
 
     // write data to a file
-    int write( char *buf, int length );
+    int write( const char *buf, const int length );
 
     // write null terminated string to a file
-    int writestring( char *str );
+    int writestring( const char *str );
 
     // close file
     bool close();
 
+    /** @return the name of the file being manipulated. */
     inline string get_file_name() const { return file_name; }
 };