Documentation fixes.

git-svn-id: https://svn.code.sf.net/p/freetel/code@1464 01035d8c-6547-0410-b346-abe4f91aad63

diff --git a/freedv-server/Doxyfile.in b/freedv-server/Doxyfile.in
index 5420e168624d67f0ef76a83d55cf3e9de89f0d98..477ac2458cfb3bb066029fa2901e7f7039620039 100644 (file)
--- a/freedv-server/Doxyfile.in
+++ b/freedv-server/Doxyfile.in
@@ -164,7 +164,7 @@ SHORT_NAMES            = NO
 # comments will behave just like regular Qt-style comments 
 # (thus requiring an explicit @brief command for a brief description.)
 
-JAVADOC_AUTOBRIEF      = NO
+JAVADOC_AUTOBRIEF      = YES
 
 # If the QT_AUTOBRIEF tag is set to YES then Doxygen will 
 # interpret the first line (until the first dot) of a Qt-style 

diff --git a/freedv-server/README.dox b/freedv-server/README.dox
index 07dd0fe5256d0a2d9b959472f9d76e82172d2524..b9b5ce02c205bf1cb5322eff7bedbf822a5bf85e 100644 (file)
--- a/freedv-server/README.dox
+++ b/freedv-server/README.dox
@@ -1,6 +1,6 @@
 /// \mainpage FreeDV Server
 /// 
-/// By Bruce Perens <bruce@perens.com>
+/// \author Bruce Perens <bruce@perens.com>
 /// 
 ///
 /// \section overview OVERVIEW
@@ -18,22 +18,10 @@
 /// generators and audio sinks for testing all parts of the program as well
 /// as drivers for actual hardware.
 ///
-/// The intent at this time is to base the event system on libevent and the
-/// audio drivers on portaudio 2.0's "blocking" interface (which provides an
-/// "I/O ready" indication and thus doesn't actually have to block). There
-/// will probably be a need to extend portaudio so that it can tie into
-/// libevent.
-///
-/// All of this software is developed using test-driven-development, with
-/// googletest as the unit test framework. The test-driven paradigm immediately
-/// showed its usefulness, as it made a few design mistakes immediately obvious.
-///
-/// Doxygen is used as the documentation system.
-///
 /// \section sponsorship SPONSORSHIP
 ///
 /// The current use of this program is HF, but it is also intended to work as
-/// part of a VHF/UHF SDR HT being developed by Algoram, the company founded
+/// part of a VHF/UHF SDR HT being developed by *Algoram*, the company founded
 /// by Chris Testa and myself. Its development is currently part of my personal
 /// investment in Algoram.
 ///
@@ -53,15 +41,17 @@
 /// under the Affero GPL Version 3, but you must comply with all of its terms,
 /// including those that require you to publish the source code of your own
 /// software under a compatible license.
-/// 
+///
 /// Alternatively, you may purchase a commercial license from Algoram, in
-/// which case you need not publish your own source code. Be advised that
-/// Algoram does not own the entire copyright of this program, specifically
-/// the codec library.  The portions of this program that we do not own are
-/// under less restrictive licenses like LGPL version 2, and we will work with
-/// your attorney and engineers to help you to deal with the intellectual
-/// property due diligence requirements of those licenses in a way that
-/// protects you from being obligated to publish your own source code.
+/// which case you need not publish your own source code.
+///
+/// Be advised that Algoram does *not* own the entire copyright of this
+/// program, specifically the codec and modem functions.
+/// The portions of this program that we do not own are under less restrictive
+/// licenses like LGPL version 2 that do not encumber your own software.
+/// We will work with the attorney and engineers of our commercial licensees
+/// to help them deal with the intellectual property due diligence requirements
+/// of those licenses.
 /// 
 /// Algoram is not a law firm and in general we work with your attorney. Only
 /// your attorney can provide you with legal advice.

diff --git a/freedv-server/source/drivers.h b/freedv-server/source/drivers.h
index d8864749292defe5ac952115fa384a3dd2505779..f85256eaa3879802cb80adc28e6ec768ce646ad2 100644 (file)
--- a/freedv-server/source/drivers.h
+++ b/freedv-server/source/drivers.h
@@ -40,7 +40,7 @@
 # endif
 #endif
 
-/// \namespace FreeDV Namespace used for all code in this program.
+/// \namespace FreeDV Namespace used for all code in the FreeDV program.
 ///
 namespace FreeDV {
 /// This propogates argv[0] so that it can be used in error messages.
@@ -321,6 +321,7 @@ public:
 };
 
 /// Virtual base class for audio input drivers.
+///
 class AudioInput : public ::FreeDV::AudioDevice {
 protected:
     /// Create an AudioInput device instance.
@@ -341,6 +342,7 @@ public:
 };
 
 /// Virtual base class for audio output drivers.
+///
 class AudioOutput : public ::FreeDV::AudioDevice {
 protected:
     /// Create an AudioOutput device instance.
@@ -361,6 +363,7 @@ public:
 };
 
 /// Virtual base class for codecs.
+///
 class Codec : public ::FreeDV::Base {
 protected:
     /// Create a codec instance.
@@ -407,6 +410,7 @@ public:
 };
 
 /// Virtual base class for protocol framers.
+///
 class Framer : public ::FreeDV::Base {
 protected:
     /// Create a framer instance.
@@ -458,6 +462,7 @@ public:
 };
 
 /// Radio device keying driver.
+///
 class KeyingOutput : public ::FreeDV::Base {
 protected:
     /// Create an radio keying output device instance.
@@ -481,6 +486,7 @@ public:
 };
 
 /// Softmodem driver.
+///
 class Modem : public ::FreeDV::Base {
 protected:
     /// Create a softmodem device instance.
@@ -524,6 +530,7 @@ public:
 };
 
 /// Push-to-talk input driver.
+///
 class PTTInput : public ::FreeDV::IODevice {
 protected:
     /// Create a push-to-talk switch instance.
@@ -541,6 +548,7 @@ public:
 };
 
 /// Driver for the text message source function.
+///
 class TextInput : public ::FreeDV::IODevice {
 protected:
     /// The child class calls this member in its parent to set the text.
@@ -785,8 +793,8 @@ TextInput * TextConstant(const char * parameter);
 UserInterface *        BlankPanel(const char * parameter, Interfaces * interfaces);
 }
 
-/// Utility functions.
-///
+// Utility functions.
+//
 
 /// Non-template version of min().
 ///

diff --git a/freedv-server/source/platform/linux/alsa.cpp b/freedv-server/source/platform/linux/alsa.cpp
index 092c779abfbccc9ba7a5318b12a407fb55878efa..6d0a06833600165a341bddbf6fa5e793533810b9 100644 (file)
--- a/freedv-server/source/platform/linux/alsa.cpp
+++ b/freedv-server/source/platform/linux/alsa.cpp
@@ -1,10 +1,9 @@
 /// \file platform/linux/alsa.cpp
 /// Functions to support the ALSA audio input and output device drivers on
 /// Linux.
-///
 /// There is at least one other operating systems that supports an ALSA-like
-// interfaces, Nucleus, but at this writing (early 2014) this driver is
-/// untested on that.
+/// interfaces, Nucleus, but at this writing (early 2014) this driver is
+/// untested on that system.
 ///
 /// \copyright Copyright (C) 2013-2014 Algoram. See the LICENSE file.
 ///

diff --git a/freedv-server/source/platform/linux/audio_in_alsa.cpp b/freedv-server/source/platform/linux/audio_in_alsa.cpp
index 8b9f3a663a03396f4f44aeb20db043feaacdebb7..7760efc387d8ea691c928295c5ea4fd997fdb504 100644 (file)
--- a/freedv-server/source/platform/linux/audio_in_alsa.cpp
+++ b/freedv-server/source/platform/linux/audio_in_alsa.cpp
@@ -1,9 +1,8 @@
 /// \file platform/linux/audio_in_alsa.cpp
 /// ALSA audio input device driver, for use on Linux.
-///
 /// There is at least one other operating systems that supports an ALSA-like
 /// interfaces, Nucleus, but at this writing (early 2014) this driver is
-/// untested on that.
+/// untested on that system.
 ///
 /// \copyright Copyright (C) 2013-2014 Algoram. See the LICENSE file.
 ///

diff --git a/freedv-server/source/platform/linux/audio_out_alsa.cpp b/freedv-server/source/platform/linux/audio_out_alsa.cpp
index fe59c8a43e63b4d95a2ecd37a97b8297ebec6939..4369ef4e7446f50008919b1936c3d0ec4476dbad 100644 (file)
--- a/freedv-server/source/platform/linux/audio_out_alsa.cpp
+++ b/freedv-server/source/platform/linux/audio_out_alsa.cpp
@@ -1,9 +1,8 @@
 /// \file platform/linux/audio_out_alsa.cpp
 /// ALSA audio output device driver, for use on Linux.
-///
 /// There is at least one other operating system that supports an ALSA-like
 /// interfaces, Nucleus, but at this writing (early 2014) this driver is
-/// untested on that.
+/// untested on that system.
 ///
 /// \copyright Copyright (C) 2013-2014 Algoram. See the LICENSE file.
 ///

diff --git a/freedv-server/source/run.cpp b/freedv-server/source/run.cpp
index f6354fcfa5288ea0a4fec820155906d7fe92a431..80f47ed4750d9bea4c2d6ec506759fbe03e244cc 100644 (file)
--- a/freedv-server/source/run.cpp
+++ b/freedv-server/source/run.cpp
@@ -10,19 +10,17 @@
 #include <stdexcept>
 #include <string.h>
 
-/// FIX:
-///
-/// Start of Transmit:
-/// Make the delay at start of transmit and end of transmit adjustable.
-/// The radio in general takes some time to begin transmitting, and thus we
-/// should not send audio until that's done.
-///
-/// End of Transmit:
-/// There is a lot to fill in for end-of-transmit.
-/// On PTT-up, we should read the remaining audio in the microphone
-/// device queue first, allow it all to drain out the transmitter, and then
-/// un-key the transmitter.
-///
+// Start of Transmit:
+// Make the delay at start of transmit and end of transmit adjustable.
+// The radio in general takes some time to begin transmitting, and thus we
+// should not send audio until that's done.
+//
+// End of Transmit:
+// There is a lot to fill in for end-of-transmit.
+// On PTT-up, we should read the remaining audio in the microphone
+// device queue first, allow it all to drain out the transmitter, and then
+// un-key the transmitter.
+//
 
 namespace FreeDV {
   /// This class implements the main loop of the FreeDV program.