Document files for doxygen.

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

diff --git a/freedv-server/source/audio_input.cpp b/freedv-server/source/audio_input.cpp
index d8e1ce17b6400870c397f4a710f55b12a0f7225a..f157790f6f83965c36671fe5d772d1e8fd3e266f 100644 (file)
--- a/freedv-server/source/audio_input.cpp
+++ b/freedv-server/source/audio_input.cpp
@@ -1,3 +1,5 @@
+/// The AudioInput class.
+
 #include "drivers.h"
 
 namespace FreeDV {

diff --git a/freedv-server/source/audio_output.cpp b/freedv-server/source/audio_output.cpp
index d34ed8a617f1e3e3013c9c3da6656d283d97e3ea..4c8829d67dc1b773fb7ca2694b4d00ff6dc64c93 100644 (file)
--- a/freedv-server/source/audio_output.cpp
+++ b/freedv-server/source/audio_output.cpp
@@ -1,3 +1,5 @@
+/// The AudioOutput class.
+
 #include "drivers.h"
 
 namespace FreeDV {

diff --git a/freedv-server/source/audio_sink.cpp b/freedv-server/source/audio_sink.cpp
index 0394bd69f7b26b29d61c0ed822fc16d621424213..5540ccdef6d63f10334d3607413f4ab7c7f96d56 100644 (file)
--- a/freedv-server/source/audio_sink.cpp
+++ b/freedv-server/source/audio_sink.cpp
@@ -1,3 +1,5 @@
+/// The AudioSink driver, called as "sink", discards the audio, for testing.
+
 #include "drivers.h"
 
 namespace FreeDV {

diff --git a/freedv-server/source/big_main.cpp b/freedv-server/source/big_main.cpp
index 7e22f45eb7224c232dabdfdd062ed3ff9c25460a..3915e48dcf5f588fab94430d072087f019364252 100644 (file)
--- a/freedv-server/source/big_main.cpp
+++ b/freedv-server/source/big_main.cpp
@@ -1,4 +1,3 @@
-#ifndef NO_INITIALIZERS
 /// This is the main program for applications that are not space-limited.
 /// Any application that is space limited should have its own main that
 /// wires drivers to the Interfaces class without using DriverManager.
@@ -8,6 +7,8 @@
 /// can to be without side-effects, a style inherited from functional
 /// programming. Thus, the excessive use of "const". - Bruce
 
+#ifndef NO_INITIALIZERS
+
 #include <stdlib.h>
 #include <string.h>
 #include <iostream>

diff --git a/freedv-server/source/blank_panel.cpp b/freedv-server/source/blank_panel.cpp
index 81cb7a25129a5510f92205c6fe2533f28e77be93..06519a82b788be2f6dd940c606e4d588da94a21f 100644 (file)
--- a/freedv-server/source/blank_panel.cpp
+++ b/freedv-server/source/blank_panel.cpp
@@ -1,3 +1,5 @@
+/// The "blank panel" GUI driver, for testing.
+
 #include "drivers.h"
 
 namespace FreeDV {

diff --git a/freedv-server/source/codec.cpp b/freedv-server/source/codec.cpp
index 2ef800609ee2e707d2ccd36f9593b95570ff3a05..6ec12a101aa8efefc5a4b78360bf7be6538a1a5f 100644 (file)
--- a/freedv-server/source/codec.cpp
+++ b/freedv-server/source/codec.cpp
@@ -1,3 +1,5 @@
+/// The Codec base class.
+
 #include "drivers.h"
 
 namespace FreeDV {

diff --git a/freedv-server/source/codec_noop.cpp b/freedv-server/source/codec_noop.cpp
index 3ad767f8de9480de7d735387af1f2e813257a19f..9204659246a576ddce26ef8e33a866974e7f4e84 100644 (file)
--- a/freedv-server/source/codec_noop.cpp
+++ b/freedv-server/source/codec_noop.cpp
@@ -1,3 +1,5 @@
+/// The No-Op Codec, for testing and plain SSB voice.
+
 #include "drivers.h"
 
 namespace FreeDV {

diff --git a/freedv-server/source/driver_manager.cpp b/freedv-server/source/driver_manager.cpp
index 324e5e43c391cb6700ad718ef7bb3b3c28bc1923..f2305bd154f3b9f38119f6727acfbc840350dd8d 100644 (file)
--- a/freedv-server/source/driver_manager.cpp
+++ b/freedv-server/source/driver_manager.cpp
@@ -1,8 +1,8 @@
+/// Device driver manager.
+/// Don't use DriverManager and big_main.cpp in space-limited applications.
+/// The STL templates it uses are too large.
+
 #ifndef NO_INITIALIZERS
-/*
- * Don't use DriverManager and main.cpp in space-limited applications.
- * STL stuff it uses is too large.
- */
 #include <iostream>
 #include "drivers.h"
 

diff --git a/freedv-server/source/keying.cpp b/freedv-server/source/keying.cpp
index 484cdffeb53cff2ce69f76528d1cc528bb4576dd..641268add5320f487f09357acae48db42b1a4fa4 100644 (file)
--- a/freedv-server/source/keying.cpp
+++ b/freedv-server/source/keying.cpp
@@ -1,3 +1,5 @@
+/// Keying driver.
+
 #include "drivers.h"
 
 namespace FreeDV {

diff --git a/freedv-server/source/keying_sink.cpp b/freedv-server/source/keying_sink.cpp
index ad6bfa5ff549954cf22d5b28b3824a7e6a87e915..1ef543d92f67cf8d37df8e8da20f5bc75e161107 100644 (file)
--- a/freedv-server/source/keying_sink.cpp
+++ b/freedv-server/source/keying_sink.cpp
@@ -1,3 +1,6 @@
+/// The KeyingSink class, called as "sink", doesn't key anything, for testing
+/// or use with VOX.
+
 #include "drivers.h"
 
 namespace FreeDV {

diff --git a/freedv-server/source/modem.cpp b/freedv-server/source/modem.cpp
index de7716f739b586770369343c07c10c6922f6dc56..a0a6bf905260bb7255eef952b04b4fcbc2c1cd1c 100644 (file)
--- a/freedv-server/source/modem.cpp
+++ b/freedv-server/source/modem.cpp
@@ -1,3 +1,5 @@
+/// The virtual base class for modem drivers.
+
 #include "drivers.h"
 
 namespace FreeDV {

diff --git a/freedv-server/source/modem_noop.cpp b/freedv-server/source/modem_noop.cpp
index ceea431d4bbd6e96bf26472827a6fcfe225703a1..37d6b5756f368288d740b05b4dae15d3abe926cf 100644 (file)
--- a/freedv-server/source/modem_noop.cpp
+++ b/freedv-server/source/modem_noop.cpp
@@ -1,3 +1,5 @@
+/// The no-op modem, for plain SSB voice and testing.
+
 #include "drivers.h"
 
 namespace FreeDV {

diff --git a/freedv-server/source/ptt_constant.cpp b/freedv-server/source/ptt_constant.cpp
index 82eae6ff3c25f9c3f86bb5c9c40b58919db35a4d..5393fa6a9302520374d3a51ffc0ae0ec0fbeb247 100644 (file)
--- a/freedv-server/source/ptt_constant.cpp
+++ b/freedv-server/source/ptt_constant.cpp
@@ -1,3 +1,5 @@
+/// The constant PTT driver, for testing.
+
 #include "drivers.h"
 
 namespace FreeDV {

diff --git a/freedv-server/source/ptt_input.cpp b/freedv-server/source/ptt_input.cpp
index fe792ed51a4135ab67f3723170c1d4b53d265802..a39fec8cded36e2c82e048c35fea6d49c078dce3 100644 (file)
--- a/freedv-server/source/ptt_input.cpp
+++ b/freedv-server/source/ptt_input.cpp
@@ -1,3 +1,5 @@
+/// The virtual base class of PTT input drivers.
+
 #include "drivers.h"
 
 namespace FreeDV {

diff --git a/freedv-server/source/run.cpp b/freedv-server/source/run.cpp
index efa417f0c3c3ee33e8074d50795a2574606c1119..95b9437d147f49648d45a935edb17dcaa3d909cf 100644 (file)
--- a/freedv-server/source/run.cpp
+++ b/freedv-server/source/run.cpp
@@ -1,3 +1,5 @@
+/// The main loop of the program.
+
 #include "drivers.h"
 
 namespace FreeDV {

diff --git a/freedv-server/source/text_constant.cpp b/freedv-server/source/text_constant.cpp
index d493bc6d61b67be9d9f3b5d6a974e3d55f4bae5a..04d40883af7c80b2ee12670acc3f781e9acec65e 100644 (file)
--- a/freedv-server/source/text_constant.cpp
+++ b/freedv-server/source/text_constant.cpp
@@ -1,3 +1,5 @@
+/// The constant text driver, just outputs the same text over and over.
+
 #include "drivers.h"
 
 namespace FreeDV {

diff --git a/freedv-server/source/text_input.cpp b/freedv-server/source/text_input.cpp
index 65f6b23be7c4ec375ef9fb625b2dc7027ef5e15b..78438b101eebc1e0f0086e90794fd22e5a0d880e 100644 (file)
--- a/freedv-server/source/text_input.cpp
+++ b/freedv-server/source/text_input.cpp
@@ -1,3 +1,5 @@
+/// The virtual base class for text input drivers.
+
 #include "drivers.h"
 
 namespace FreeDV {

diff --git a/freedv-server/source/tiny_main.cpp b/freedv-server/source/tiny_main.cpp
index c3b86ba9cbf2ad3288022569b726d274e9d1fe29..ef2029db7441cd0e25bb82162b9958b67dbb4fa1 100644 (file)
--- a/freedv-server/source/tiny_main.cpp
+++ b/freedv-server/source/tiny_main.cpp
@@ -1,3 +1,5 @@
+/// The tiny main program for embedded use.
+
 #ifdef NO_INITIALIZERS
 /*
  * Main program for embedded use.

diff --git a/freedv-server/source/tone.cpp b/freedv-server/source/tone.cpp
index 1412b70308a64525bcfde105937a895bbb9acda8..8f50f9b897143ae987dbb476eba01676d79d737a 100644 (file)
--- a/freedv-server/source/tone.cpp
+++ b/freedv-server/source/tone.cpp
@@ -1,3 +1,5 @@
+/// The tone audio input driver, for testing.
+
 #include "drivers.h"
 
 namespace FreeDV {

diff --git a/freedv-server/source/user_interface.cpp b/freedv-server/source/user_interface.cpp
index 2721ece027b369b245dd0e646c33c80625d45cf5..d85f42c53b676dd23e57d05ddd5f0c6ca4d42787 100644 (file)
--- a/freedv-server/source/user_interface.cpp
+++ b/freedv-server/source/user_interface.cpp
@@ -1,3 +1,5 @@
+/// The virtual base class for user interface drivers.
+
 #include "drivers.h"
 
 namespace FreeDV {