X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=simgear%2Fio%2Fsg_serial.hxx;h=b6e43cb7ead436b6ef1ea811f436c6f56f8b95f6;hb=2d21e59b54dcaafe1ee480438b63460fae4afdd6;hp=87c218771ce5d81fb24ff05da711410ed0e12fd9;hpb=c16b9ed25b9c8d7229153787aa1492e4ea37b61e;p=simgear.git

diff --git a/simgear/io/sg_serial.hxx b/simgear/io/sg_serial.hxx
index 87c21877..b6e43cb7 100644
--- a/simgear/io/sg_serial.hxx
+++ b/simgear/io/sg_serial.hxx
@@ -1,5 +1,8 @@
-// sg_serial.hxx -- Serial I/O routines
-//
+/**
+ * \file sg_serial.hxx
+ * Serial I/O routines
+ */
+
 // Written by Curtis Olson, started November 1999.
 //
 // Copyright (C) 1999  Curtis L. Olson - curt@flightgear.org
@@ -45,7 +48,9 @@
 
 SG_USING_STD(string);
 
-
+/**
+ * A serial I/O class based on SGIOChannel.
+ */
 class SGSerial : public SGIOChannel {
 
     string device;
@@ -57,7 +62,21 @@ class SGSerial : public SGIOChannel {
 
 public:
 
+    /**
+     * Create an instance of SGSerial.
+     * This creates an instance of the SGSerial class. You need to
+     * provide the serial device name and desired baud rate.  For Unix
+     * style systems, device names will be similar to
+     * ``/dev/ttyS0''. For DOS style systems you may want to use
+     * something similar to ``COM1:''. As with the SGFile class,
+     * device is not opened immediately, but instead will be opened
+     * when the open() method is called.
+     * @param device_name name of serial device
+     * @param baud_rate speed of communication
+     */
     SGSerial( const string& device_name, const string& baud_rate );
+
+    /** Destructor */
     ~SGSerial();
 
     // open the serial port based on specified direction
@@ -78,7 +97,10 @@ public:
     // close port
     bool close();
 
+    /** @return the serial port device name */
     inline string get_device() const { return device; }
+
+    /** @return the baud rate */
     inline string get_baud() const { return baud; }
 };