Doxygen: fill in missing file level headlines for some supplemental code

src/proc/control/media-impl-lib.hpp

@@ -1,5 +1,5 @@
 /*
-  MEDIAIMPLLIB.hpp  -  interface providing a facade to an media handling library
+  MEDIA-IMPL-LIB.hpp  -  facade interface to access an external media handling library
 
   Copyright (C)         Lumiera.org
     2008,               Hermann Vosseler <Ichthyostega@web.de>
@@ -21,7 +21,7 @@
 */
 
 
-/** @file mediaimpllib.hpp
+/** @file media-impl-lib.hpp
  ** Abstraction to represent (metadata) of an external library to handle media data
  ** Lumiera delegates most actual media data processing to well established external
  ** libraries. While configuring the render process, a [stream type](streamtype.hpp)
@@ -33,8 +33,8 @@
  */
 
 
-#ifndef CONTROL_MEDIAIMPLLIB_H
+#ifndef PROC_CONTROL_MEDIA_IMPL_LIB_H
-#define CONTROL_MEDIAIMPLLIB_H
+#define PROC_CONTROL_MEDIA_IMPL_LIB_H
 
 
 #include "proc/streamtype.hpp"
@@ -64,4 +64,4 @@ namespace control {
   
   
 }} // namespace proc::control
-#endif
+#endif /*PROC_CONTROL_MEDIA_IMPL_LIB_H*/

src/proc/external/libgavl.cpp

@@ -22,7 +22,8 @@
 
 
 /** @file libgavl.cpp
- ** TODO libgavl.cpp
+ ** Implementation details of using the GAVL library for processing
+ ** @todo 2016 evaluate if libGAVL is still active and maintained
  */
 
 
@@ -59,7 +60,7 @@ namespace external {
    * Use an type information struct, which actually has to be 
    * a GAVL frame type (TODO), to wire up an ImplFacade such
    * as to deal with GAVL data frames of this type.
-   * @todo fill in the acutal GAVL frame type 
+   * @todo fill in the actual GAVL frame type
    * @todo how to distinguish the audio and the video case?
    */
   ImplFacadeGAVL const&

src/proc/external/libgavl.hpp

@@ -22,7 +22,11 @@
 
 
 /** @file libgavl.hpp
- ** TODO libgavl.hpp
+ ** Concrete implementation of the MediaImplLib facade to work with `libGAVL`
+ ** @todo a draft and placeholder code from 2008, at which time the intention was
+ **       to rely on libGAVL for processing of raw media data. This seemed like a
+ **       good idea at that time, but we should re-evaluate if libGAVL is maintained
+ **       and in actual use, before we start really relying on it
  */
 
 
@@ -30,7 +34,7 @@
 #define PROC_EXTERNAL_LIBGAVL_H
 
 
-#include "proc/control/mediaimpllib.hpp"
+#include "proc/control/media-impl-lib.hpp"
 
 
 
@@ -52,6 +56,7 @@ namespace external {
    * in an implementation agnostic way.
    * @note GAVL types are automagically registered into the
    * control::STypeManager on reset and thus are always available.
+   * @todo 2016 evaluate if libGAVL is still active and maintained
    */
   class ImplFacadeGAVL
     : public ImplFacade

src/tool/alsa.c

@@ -22,7 +22,7 @@
 
 
 /** @file alsa.c
- ** TODO alsa.c
+ ** Example implementation how to access the ALSA sound backend
  */
 
 

src/tool/alsa.h

@@ -22,6 +22,7 @@
 
 /** @file alsa.h
  ** Interfacing to ALSA sound output.
+ ** @remarks Example implementation from 2011
  ** 
  ** @todo for now this header defines some functions used for experimentation with ALSA 
  **

src/tool/hello.c

@@ -5,7 +5,7 @@
 
 
 /** @file hello.c
- ** TODO hello.c
+ ** Example file to demonstrate integration of stand-alone tools into the build process
  */
 
 #include <stdio.h>

src/tool/main.c

@@ -22,7 +22,10 @@
 
 
 /** @file main.c
- ** TODO main.c
+ ** A stand alone application to test integration with output frameworks
+ ** @remarks the plan was to evolve this into a command line tool eventually,
+ **          which would use Lumiera's backend functionality to setup and probe
+ **          the operation environment for diagnostic purpose
  */
 
 

src/tool/rsvg-convert.c

@@ -25,7 +25,10 @@
 
 
 /** @file rsvg-convert.c
- ** TODO rsvg-convert.c
+ ** Invoke the rSVG library to render SVG vector graphics with the help of Cairo.
+ ** @note This tool is tightly integrated into the Lumiera build process in order
+ **       to render icons and UI decorations designed as vector graphics, for those
+ **       cases where it is beneficial to use bitmap graphics within the UI toolkit.
  */