X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=simgear%2Fserial%2Fserial.hxx;h=83cc60085fc7150a69aedc851fb346aecb4974af;hb=0a2264cad465fcca6ea9679f1db139d6ee6cd3e6;hp=757b10d7bd919915c5403c562e9cb3a650985575;hpb=c16b9ed25b9c8d7229153787aa1492e4ea37b61e;p=simgear.git

diff --git a/simgear/serial/serial.hxx b/simgear/serial/serial.hxx
index 757b10d7..83cc6008 100644
--- a/simgear/serial/serial.hxx
+++ b/simgear/serial/serial.hxx
@@ -1,8 +1,11 @@
-// serial.hxx -- Unix serial I/O support
-//
+/**
+ * \file serial.hxx
+ * Low level serial I/O support (for unix/cygwin and windows)
+ */
+
 // Written by Curtis Olson, started November 1998.
 //
-// Copyright (C) 1998  Curtis L. Olson - curt@flightgear.org
+// Copyright (C) 1998  Curtis L. Olson - http://www.flightgear.org/~curt
 //
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Library General Public
@@ -14,10 +17,9 @@
 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 // Library General Public License for more details.
 //
-// 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.
+// 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 //
 // $Id$
 
@@ -30,23 +32,22 @@
 # error This library requires C++
 #endif
 
-#ifdef HAVE_CONFIG_H
-#  include <config.h>
-#endif
-
 #if defined( WIN32 ) && !defined( __CYGWIN__) && !defined( __CYGWIN32__ )
 #  include <windows.h>
 #endif
 
 #include <simgear/compiler.h>
-#include STL_STRING
-SG_USING_STD(string);
+#include <string>
+using std::string;
 
 // if someone know how to do this all with C++ streams let me know
 // #include <stdio.h>
 
 
-class FGSerialPort
+/**
+ * A class to encapsulate low level serial port IO.
+ */
+class SGSerialPort
 {
 #if defined( WIN32 ) && !defined( __CYGWIN__) && !defined( __CYGWIN32__ )
     typedef HANDLE fd_type;
@@ -61,19 +62,62 @@ private:
 
 public:
 
-    FGSerialPort();
-    FGSerialPort(const string& device, int baud);
+    /** Default constructor */
+    SGSerialPort();
+
+    /**
+     * Constructor
+     * @param device device name
+     * @param baud baud rate
+     */
+    SGSerialPort(const string& device, int baud);
 
-    ~FGSerialPort();
+    /** Destructor */
+    ~SGSerialPort();
 
+    /** Open a the serial port
+     * @param device name of device
+     * @return success/failure
+     */
     bool open_port(const string& device);
+
+    /** Close the serial port
+     * @return success/failure 
+     */
     bool close_port();
+
+    /** Set baud rate
+     * @param baud baud rate
+     * @return success/failure
+     */
     bool set_baud(int baud);
+
+    /** Read from the serial port
+     * @return line of data
+     */
     string read_port();
+
+    /** Read from the serial port
+     * @param buf input buffer
+     * @param len length of buffer (i.e. max number of bytes to read
+     * @return number of bytes read
+     */
     int read_port(char *buf, int len);
+
+    /** Write to the serial port
+     * @param value output string
+     * @return number of bytes written
+     */
     int write_port(const string& value);
+
+    /** Write to the serial port
+     * @param buf pointer to character buffer containing output data
+     * @param len number of bytes to write from the buffer
+     * @return number of bytes written
+     */
     int write_port(const char *buf, int len);
 
+    /** @return true if device open */
     inline bool is_enabled() { return dev_open; }
 };