From: curt <curt>
Date: Sun, 25 Mar 2001 13:27:50 +0000 (+0000)
Subject: Doxygen ...
X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=828a9a8c51b6aacf641c33c664c55809fe385e99;p=simgear.git

Doxygen ...
---

diff --git a/simgear/misc/zfstream.hxx b/simgear/misc/zfstream.hxx
index 0b281456..cfd7731a 100644
--- a/simgear/misc/zfstream.hxx
+++ b/simgear/misc/zfstream.hxx
@@ -188,7 +188,7 @@ struct gzifstream_base
 {
     gzifstream_base() {}
 
-    Gzfilebuf gzbuf;
+    gzfilebuf gzbuf;
 };
 
 #endif // _zfstream_hxx
diff --git a/simgear/screen/screen-dump.hxx b/simgear/screen/screen-dump.hxx
index c9976d38..41da1b05 100644
--- a/simgear/screen/screen-dump.hxx
+++ b/simgear/screen/screen-dump.hxx
@@ -1,5 +1,8 @@
-// screen-dump.hxx -- dump a copy of the opengl screen buffer to a file
-//
+/**
+ * \file screen-dump.hxx
+ * Dump a copy of the opengl screen buffer to a file.
+ */
+
 // Contributed by Richard Kaszeta <bofh@me.umn.edu>, started October 1999.
 //
 // This library is free software; you can redistribute it and/or
@@ -20,8 +23,22 @@
 // $Id$
 
 
-// dump the screen buffer to a ppm file
+/**
+ * Dump the screen buffer to a ppm file.
+ * @param filename name of file
+ * @param win_width width of our opengl window
+ * @param win_height height of our opengl window
+ */
 void my_glDumpWindow( const char *filename, int win_width, int win_height );
 
+
+/**
+ * Given a GLubyte *buffer, write it out to a ppm file.
+ * @param filename name of file
+ * @param buffer pointer to opengl buffer
+ * @param win_width width of buffer
+ * @param win_height height of buffer
+ * @param mode one of GL_RGBA, GL_RGB, etc.
+ */
 void my_glWritePPMFile( const char *filename, GLubyte *buffer, int win_width, 
 		        int win_height, int mode);
diff --git a/simgear/serial/serial.hxx b/simgear/serial/serial.hxx
index 757b10d7..7534372c 100644
--- a/simgear/serial/serial.hxx
+++ b/simgear/serial/serial.hxx
@@ -1,5 +1,8 @@
-// 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
@@ -46,6 +49,9 @@ SG_USING_STD(string);
 // #include <stdio.h>
 
 
+/**
+ * A class to encapsulate low level serial port IO.
+ */
 class FGSerialPort
 {
 #if defined( WIN32 ) && !defined( __CYGWIN__) && !defined( __CYGWIN32__ )
@@ -61,19 +67,62 @@ private:
 
 public:
 
+    /** Default constructor */
     FGSerialPort();
+
+    /**
+     * Constructor
+     * @param device device name
+     * @param baud baud rate
+     */
     FGSerialPort(const string& device, int baud);
 
+    /** Destructor */
     ~FGSerialPort();
 
+    /** 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; }
 };