From 395e3450d7ed775741d52bb8b19675a0e071f675 Mon Sep 17 00:00:00 2001
From: bruceperens <bruceperens@01035d8c-6547-0410-b346-abe4f91aad63>
Date: Thu, 16 Jan 2014 05:39:28 +0000
Subject: [PATCH] Document files for doxygen.

git-svn-id: https://svn.code.sf.net/p/freetel/code@1358 01035d8c-6547-0410-b346-abe4f91aad63
---
 freedv-server/source/audio_input.cpp    | 2 ++
 freedv-server/source/audio_output.cpp   | 2 ++
 freedv-server/source/audio_sink.cpp     | 2 ++
 freedv-server/source/big_main.cpp       | 3 ++-
 freedv-server/source/blank_panel.cpp    | 2 ++
 freedv-server/source/codec.cpp          | 2 ++
 freedv-server/source/codec_noop.cpp     | 2 ++
 freedv-server/source/driver_manager.cpp | 8 ++++----
 freedv-server/source/keying.cpp         | 2 ++
 freedv-server/source/keying_sink.cpp    | 3 +++
 freedv-server/source/modem.cpp          | 2 ++
 freedv-server/source/modem_noop.cpp     | 2 ++
 freedv-server/source/ptt_constant.cpp   | 2 ++
 freedv-server/source/ptt_input.cpp      | 2 ++
 freedv-server/source/run.cpp            | 2 ++
 freedv-server/source/text_constant.cpp  | 2 ++
 freedv-server/source/text_input.cpp     | 2 ++
 freedv-server/source/tiny_main.cpp      | 2 ++
 freedv-server/source/tone.cpp           | 2 ++
 freedv-server/source/user_interface.cpp | 2 ++
 20 files changed, 43 insertions(+), 5 deletions(-)

diff --git a/freedv-server/source/audio_input.cpp b/freedv-server/source/audio_input.cpp
index d8e1ce17..f157790f 100644
--- 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 d34ed8a6..4c8829d6 100644
--- 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 0394bd69..5540ccde 100644
--- 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 7e22f45e..3915e48d 100644
--- 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 81cb7a25..06519a82 100644
--- 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 2ef80060..6ec12a10 100644
--- 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 3ad767f8..92046592 100644
--- 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 324e5e43..f2305bd1 100644
--- 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 484cdffe..641268ad 100644
--- 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 ad6bfa5f..1ef543d9 100644
--- 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 de7716f7..a0a6bf90 100644
--- 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 ceea431d..37d6b575 100644
--- 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 82eae6ff..5393fa6a 100644
--- 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 fe792ed5..a39fec8c 100644
--- 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 efa417f0..95b9437d 100644
--- 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 d493bc6d..04d40883 100644
--- 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 65f6b23b..78438b10 100644
--- 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 c3b86ba9..ef2029db 100644
--- 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 1412b703..8f50f9b8 100644
--- 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 2721ece0..d85f42c5 100644
--- 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 {
-- 
2.25.1