Improve Doxygen mainpage

8 files changed, 33 insertions, 23 deletions

diff --git a/libtoolame-dab/toolame.h b/libtoolame-dab/toolame.h
index bb73b70..998ac4f 100644
--- a/libtoolame-dab/toolame.h
+++ b/libtoolame-dab/toolame.h
@@ -1,4 +1,6 @@
 /*! \section libtoolame API
+ *  \file toolame.h
+ *  \brief The libtoolame API
  */
 #ifndef __TOOLAME_H_
 #define __TOOLAME_H_
diff --git a/src/AlsaInput.h b/src/AlsaInput.h
index a17134b..a261f37 100644
--- a/src/AlsaInput.h
+++ b/src/AlsaInput.h
@@ -16,7 +16,7 @@
  * and limitations under the License.
  * -------------------------------------------------------------------
  */
-/*! \section ALSA Input
+/*! \file AlsaInput.h
  *
  * This input uses libasound to get audio data.
  */
diff --git a/src/JackInput.h b/src/JackInput.h
index ba4834e..23fd4b6 100644
--- a/src/JackInput.h
+++ b/src/JackInput.h
@@ -16,7 +16,7 @@
  * and limitations under the License.
  * -------------------------------------------------------------------
  */
-/*! \section JACK Input
+/*! \file JackInput.h
  *
  * This input uses JACK to get audio data. This always uses drift
  * compensation, because there is no blocking way to read from JACK.
diff --git a/src/SampleQueue.h b/src/SampleQueue.h
index 994672f..dd01986 100644
--- a/src/SampleQueue.h
+++ b/src/SampleQueue.h
@@ -18,9 +18,8 @@
  */
 
 /*!
- * \section SampleQueue
- *
- * An implementation for a threadsafe queue using the C++11 thread library
+ * \file SampleQueue.h
+ * \brief An implementation for a threadsafe queue using the C++11 thread library
  * for audio samples.
  */
 
diff --git a/src/VLCInput.cpp b/src/VLCInput.cpp
index 4831915..9f0aa65 100644
--- a/src/VLCInput.cpp
+++ b/src/VLCInput.cpp
@@ -34,7 +34,7 @@ int check_vlc_uses_size_t();
 
 using namespace std;
 
-/*! VLC callback functions have to be C functions.
+/*! \note VLC callback functions have to be C functions.
  * These wrappers call the VLCInput functions
  */
 
@@ -335,7 +335,7 @@ ssize_t VLCInput::m_read(uint8_t* buf, size_t length)
     return err;
 }
 
-/* Write the corresponding text to a file readable by mot-encoder, with optional
+/*! Write the corresponding text to a file readable by mot-encoder, with optional
  * DL+ information. The text is passed as a copy because we actually use the
  * m_nowplaying variable which is also accessed in another thread, so better
  * make a copy.
diff --git a/src/VLCInput.h b/src/VLCInput.h
index 6f91e89..761492b 100644
--- a/src/VLCInput.h
+++ b/src/VLCInput.h
@@ -15,7 +15,7 @@
  * and limitations under the License.
  * -------------------------------------------------------------------
  */
-/*! \section VLC Input
+/*! \file VLCInput.h
  *
  * This input uses libvlc to get audio data. It is extremely useful, and allows
  * the encoder to use all inputs VLC supports.
diff --git a/src/dabplus-enc.cpp b/src/dabplus-enc.cpp
index 953073d..35a7496 100644
--- a/src/dabplus-enc.cpp
+++ b/src/dabplus-enc.cpp
@@ -32,16 +32,23 @@
  *  The readme for the whole package is \ref md_README
  *
  *  Interesting starting points for the encoder
- *  - \ref dabplus-enc.cpp
- *  - \ref VLC Input
- *  - \ref Alsa Input
- *  - \ref JACK Input
- *  - \ref SampleQueue
- *  - \ref charset.h
- *  - \ref libtoolame API
+ *  - \ref dabplus-enc.cpp Main encoder file
+ *  - \ref VLCInput.h VLC Input
+ *  - \ref AlsaInput.h Alsa Input
+ *  - \ref JackInput.h JACK Input
+ *  - \ref SampleQueue.h
+ *  - \ref charset.h Charset conversion
+ *  - \ref toolame.h libtolame API
+ *  - \ref AudioLevel
+ *  - \ref DataInput
+ *  - \ref SilenceDetection
  *
  *  For the mot-encoder:
  *  - \ref mot-encoder.cpp
+ *
+ *
+ *  \file dabplus-enc.cpp
+ *  \brief The main file for the audio encoder
  */
 
 #include "config.h"
@@ -904,7 +911,7 @@ int main(int argc, char *argv[])
         memset(&outbuf[0], 0x00, outbuf_size);
         memset(&input_buf[0], 0x00, input_buf.size());
 
-        /*! \section Data input
+        /*! \section DataInput
          * We read data input either in a blocking way (file input, VLC or ALSA
          * without drift compensation) or in a non-blocking way (VLC or ALSA
          * with drift compensation, JACK).
@@ -1013,7 +1020,8 @@ int main(int argc, char *argv[])
 #endif
         }
 
-        /*! Audio level measurement is always done assuming we have two
+        /*! \section AudioLevel
+         * Audio level measurement is always done assuming we have two
          * channels, and is formally wrong in mono, but still gives
          * numbers one can use.
          *
@@ -1026,7 +1034,8 @@ int main(int argc, char *argv[])
             peak_right = MAX(peak_right, r);
         }
 
-        /*! Silence detection, looks at the audio level and is
+        /*! \section SilenceDetection
+         * Silence detection looks at the audio level and is
          * only useful if the connection dropped, or if no data is available. It is not
          * useful if the source is nearly silent (some noise present), because the
          * threshold is 0, and not configurable. The rationale is that we want to
@@ -1114,7 +1123,7 @@ int main(int argc, char *argv[])
                 }
             }
 
-            /*! toolame expects the audio to be in another shape as
+            /*! \note toolame expects the audio to be in another shape as
              * we have in input_buf, and we need to convert first
              */
             short input_buffers[2][1152];
@@ -1143,9 +1152,9 @@ int main(int argc, char *argv[])
             }
         }
 
-        /*! Check if the encoder has generated output data.
-         *  DAB+ requires RS encoding, which is not done in ODR-DabMux and not necessary
-         *  for DAB.
+        /* Check if the encoder has generated output data.
+         * DAB+ requires RS encoding, which is not done in ODR-DabMux and not necessary
+         * for DAB.
          */
         if (numOutBytes != 0 and
             selected_encoder == encoder_selection_t::fdk_dabplus) {
diff --git a/src/mot-encoder.cpp b/src/mot-encoder.cpp
index 00757f6..8393bb7 100644
--- a/src/mot-encoder.cpp
+++ b/src/mot-encoder.cpp
@@ -19,7 +19,7 @@
     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 /*!
-    \file mot-encoder.c
+    \file mot-encoder.cpp
     \brief Generete PAD data for MOT Slideshow and DLS
 
     \author Sergio Sagliocco <sergio.sagliocco@csp.it>