From bb139a5c73a690f79e0ec75d1ff6ad63ef774ba4 Mon Sep 17 00:00:00 2001 From: Ichthyostega Date: Wed, 9 Nov 2016 20:09:19 +0100 Subject: [PATCH] Doxygen: fill in missing file level headlines for some supplemental code --- .../control/{mediaimpllib.hpp => media-impl-lib.hpp} | 10 +++++----- src/proc/external/libgavl.cpp | 7 ++++--- src/proc/external/libgavl.hpp | 9 +++++++-- src/tool/alsa.c | 2 +- src/tool/alsa.h | 1 + src/tool/hello.c | 2 +- src/tool/main.c | 5 ++++- src/tool/rsvg-convert.c | 5 ++++- 8 files changed, 27 insertions(+), 14 deletions(-) rename src/proc/control/{mediaimpllib.hpp => media-impl-lib.hpp} (89%) diff --git a/src/proc/control/mediaimpllib.hpp b/src/proc/control/media-impl-lib.hpp similarity index 89% rename from src/proc/control/mediaimpllib.hpp rename to src/proc/control/media-impl-lib.hpp index cf60e101d..08496ca30 100644 --- a/src/proc/control/mediaimpllib.hpp +++ b/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 @@ -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 -#define CONTROL_MEDIAIMPLLIB_H +#ifndef PROC_CONTROL_MEDIA_IMPL_LIB_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*/ diff --git a/src/proc/external/libgavl.cpp b/src/proc/external/libgavl.cpp index 892869435..99864d482 100644 --- a/src/proc/external/libgavl.cpp +++ b/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 */ @@ -57,9 +58,9 @@ namespace external { /** * Use an type information struct, which actually has to be - * a GAVL frametype (TODO), to wire up an ImplFacade such + * 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& diff --git a/src/proc/external/libgavl.hpp b/src/proc/external/libgavl.hpp index b16da7e27..1189c0abb 100644 --- a/src/proc/external/libgavl.hpp +++ b/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 diff --git a/src/tool/alsa.c b/src/tool/alsa.c index 738a95a8e..83cd839c7 100644 --- a/src/tool/alsa.c +++ b/src/tool/alsa.c @@ -22,7 +22,7 @@ /** @file alsa.c - ** TODO alsa.c + ** Example implementation how to access the ALSA sound backend */ diff --git a/src/tool/alsa.h b/src/tool/alsa.h index 30fdb75f7..082ed8388 100644 --- a/src/tool/alsa.h +++ b/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 ** diff --git a/src/tool/hello.c b/src/tool/hello.c index 6de1b0003..471efc0c9 100644 --- a/src/tool/hello.c +++ b/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 diff --git a/src/tool/main.c b/src/tool/main.c index 7887362c8..d0e096b64 100644 --- a/src/tool/main.c +++ b/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 */ diff --git a/src/tool/rsvg-convert.c b/src/tool/rsvg-convert.c index 46a21dc78..0bcb905ac 100644 --- a/src/tool/rsvg-convert.c +++ b/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. */