From b4e0f6bf4075bcc6d63fae90d99b1da3a68824b3 Mon Sep 17 00:00:00 2001 From: Ichthyostega Date: Wed, 22 Feb 2017 03:46:23 +0100 Subject: [PATCH] Doxygen: fill in the last missing file level comments for plain-C tests now each and every source file should be marked with a @file doxygen comment --- tests/backend/test-filedescriptors.c | 7 ++++--- tests/backend/test-filehandles.c | 5 +++-- tests/backend/test-fileheader.c | 5 +++-- tests/backend/test-filemmap.c | 7 ++++--- tests/backend/test-resourcecollector.c | 5 +++-- tests/backend/test-threadpool.c | 4 ++-- tests/backend/test-threads.c | 8 ++++++-- tests/core/application/test-configloader.c | 5 +++-- tests/core/application/test-interfaces.c | 6 ++++-- tests/library/c-lib/test-errorstate.c | 6 ++++-- tests/library/c-lib/test-llist.c | 5 +++-- tests/library/c-lib/test-locking.c | 8 ++++++-- tests/library/c-lib/test-luid.c | 6 ++++-- tests/library/c-lib/test-mpool.c | 7 +++++-- tests/library/c-lib/test-priqueue.c | 5 +++-- tests/library/c-lib/test-psplay.c | 7 +++++-- tests/library/c-lib/test-safeclib.c | 5 +++-- tests/library/c-lib/test-slist.c | 4 ++-- tests/library/c-lib/test-time.c | 7 +++++-- tests/library/meta/dummy-functions.hpp | 2 +- 20 files changed, 73 insertions(+), 41 deletions(-) diff --git a/tests/backend/test-filedescriptors.c b/tests/backend/test-filedescriptors.c index 4b0cc7136..904228dac 100644 --- a/tests/backend/test-filedescriptors.c +++ b/tests/backend/test-filedescriptors.c @@ -1,5 +1,5 @@ /* - TEST-FILEDESCRIPTORS + TEST-FILEDESCRIPTORS - verify filedescriptor management Copyright (C) Lumiera.org 2008, Christian Thaeter @@ -20,8 +20,9 @@ * *****************************************************/ -/** @file §§§ - ** unit test §§TODO§§ +/** @file test-filedescriptors.c + ** C unit test to cover filedescriptor management + ** @see filedescriptor.h */ diff --git a/tests/backend/test-filehandles.c b/tests/backend/test-filehandles.c index 3040881f3..83da58793 100644 --- a/tests/backend/test-filehandles.c +++ b/tests/backend/test-filehandles.c @@ -20,8 +20,9 @@ * *****************************************************/ -/** @file §§§ - ** unit test §§TODO§§ +/** @file test-filehandles.c + ** C unit test to cover management for filehandles and the filehandle cache + ** @see filehandlecache.h */ diff --git a/tests/backend/test-fileheader.c b/tests/backend/test-fileheader.c index 84045fef8..70985b67c 100644 --- a/tests/backend/test-fileheader.c +++ b/tests/backend/test-fileheader.c @@ -20,8 +20,9 @@ * *****************************************************/ -/** @file §§§ - ** unit test §§TODO§§ +/** @file test-fileheader.c + ** C unit test to verify file identification functions + ** @see fileheader.h */ diff --git a/tests/backend/test-filemmap.c b/tests/backend/test-filemmap.c index dd1219f9b..4a2159ec1 100644 --- a/tests/backend/test-filemmap.c +++ b/tests/backend/test-filemmap.c @@ -1,5 +1,5 @@ /* - TEST-FILEMAP - test file management + TEST-FILEMAP - test file memory mapping Copyright (C) Lumiera.org 2008, Christian Thaeter @@ -20,8 +20,9 @@ * *****************************************************/ -/** @file §§§ - ** unit test §§TODO§§ +/** @file test-filemmap.c + ** C unit test to cover memory mapping of file contents + ** @see mmapings.h */ diff --git a/tests/backend/test-resourcecollector.c b/tests/backend/test-resourcecollector.c index 267dab37c..b55ec115f 100644 --- a/tests/backend/test-resourcecollector.c +++ b/tests/backend/test-resourcecollector.c @@ -20,8 +20,9 @@ * *****************************************************/ -/** @file §§§ - ** unit test §§TODO§§ +/** @file test-resourcecollector.c + ** C unit test to cover management of low-level resources for the backend + ** @see resourcecollector.h */ diff --git a/tests/backend/test-threadpool.c b/tests/backend/test-threadpool.c index 3c79f7e6c..9320b94c5 100644 --- a/tests/backend/test-threadpool.c +++ b/tests/backend/test-threadpool.c @@ -20,8 +20,8 @@ * *****************************************************/ -/** @file §§§ - ** unit test §§TODO§§ +/** @file test-threadpool.c + ** C unit test to cover our threadpool implementation */ diff --git a/tests/backend/test-threads.c b/tests/backend/test-threads.c index 64a388a1e..395680d0e 100644 --- a/tests/backend/test-threads.c +++ b/tests/backend/test-threads.c @@ -20,8 +20,12 @@ * *****************************************************/ -/** @file §§§ - ** unit test §§TODO§§ +/** @file test-threads.c + ** C unit test to cover thread handling helpers + ** Especially, we rely on a specific setup for threads, which allows + ** to manage worker threads in a threadpool + ** @see threads.h + ** @see test-threadpool.c */ diff --git a/tests/core/application/test-configloader.c b/tests/core/application/test-configloader.c index e9ab6a21b..bfd75a7e7 100644 --- a/tests/core/application/test-configloader.c +++ b/tests/core/application/test-configloader.c @@ -21,8 +21,9 @@ * *****************************************************/ -/** @file §§§ - ** unit test §§TODO§§ +/** @file test-configloader.c + ** C unit test to cover a config system draft implementation + ** @deprecated as of 2017 it is very likely we'll use a different approach */ diff --git a/tests/core/application/test-interfaces.c b/tests/core/application/test-interfaces.c index 1acfc51f3..bbae36bf5 100644 --- a/tests/core/application/test-interfaces.c +++ b/tests/core/application/test-interfaces.c @@ -20,8 +20,10 @@ * *****************************************************/ -/** @file §§§ - ** unit test §§TODO§§ +/** @file test-interfaces.c + ** C unit test to cover the basics of our interface and plugin-loading system + ** @see interface.h + ** @see interfaceregistry.h */ diff --git a/tests/library/c-lib/test-errorstate.c b/tests/library/c-lib/test-errorstate.c index 080a4bdf0..16e83af11 100644 --- a/tests/library/c-lib/test-errorstate.c +++ b/tests/library/c-lib/test-errorstate.c @@ -20,8 +20,10 @@ * *****************************************************/ -/** @file §§§ - ** unit test §§TODO§§ +/** @file test-errorstate.c + ** C unit test to cover basic error handling in C code + ** We manage an _errorstate variable_ in thread local storage, + ** which allows to set an global error state per thread. */ diff --git a/tests/library/c-lib/test-llist.c b/tests/library/c-lib/test-llist.c index 2d1b5ceca..e97af241f 100644 --- a/tests/library/c-lib/test-llist.c +++ b/tests/library/c-lib/test-llist.c @@ -20,8 +20,9 @@ * *****************************************************/ -/** @file §§§ - ** unit test §§TODO§§ +/** @file test-llist.c + ** C unit test to cover a linked list library implementation + ** @see llist.h */ diff --git a/tests/library/c-lib/test-locking.c b/tests/library/c-lib/test-locking.c index f2601db22..7703a6a8f 100644 --- a/tests/library/c-lib/test-locking.c +++ b/tests/library/c-lib/test-locking.c @@ -20,8 +20,12 @@ * *****************************************************/ -/** @file §§§ - ** unit test §§TODO§§ +/** @file test-locking.c + ** C unit test to cover convenience setup for POSIX locking primitives + ** These convenience macros are intended for use in low-level C code, + ** where minimal and precise locking is relevant for performance reasons. + ** @see mutex.h + ** @see condition.h */ diff --git a/tests/library/c-lib/test-luid.c b/tests/library/c-lib/test-luid.c index 01f26eef5..d49ebc68c 100644 --- a/tests/library/c-lib/test-luid.c +++ b/tests/library/c-lib/test-luid.c @@ -20,8 +20,10 @@ * *****************************************************/ -/** @file §§§ - ** unit test §§TODO§§ +/** @file test-luid.c + ** C unit test to cover generation of Lumiera Uniform Identifier hashes + ** @see luid.h + ** @see hash-indexed.hpp */ diff --git a/tests/library/c-lib/test-mpool.c b/tests/library/c-lib/test-mpool.c index a15e864a0..231c16955 100644 --- a/tests/library/c-lib/test-mpool.c +++ b/tests/library/c-lib/test-mpool.c @@ -20,8 +20,11 @@ * *****************************************************/ -/** @file §§§ - ** unit test §§TODO§§ +/** @file test-mpool.c + ** C unit test to cover a memory pool custom allocator + ** + ** @warning unfinished implementation as of 2016 + ** @see mpool.h */ diff --git a/tests/library/c-lib/test-priqueue.c b/tests/library/c-lib/test-priqueue.c index b5c25e1b8..ff3c86510 100644 --- a/tests/library/c-lib/test-priqueue.c +++ b/tests/library/c-lib/test-priqueue.c @@ -20,8 +20,9 @@ * *****************************************************/ -/** @file §§§ - ** unit test §§TODO§§ +/** @file test-priqueue.c + ** C unit test to cover a priority queue library implementation + ** @see priqueue.h */ diff --git a/tests/library/c-lib/test-psplay.c b/tests/library/c-lib/test-psplay.c index e8effdb19..fd9760f6b 100644 --- a/tests/library/c-lib/test-psplay.c +++ b/tests/library/c-lib/test-psplay.c @@ -20,8 +20,11 @@ * *****************************************************/ -/** @file §§§ - ** unit test §§TODO§§ +/** @file test-psplay.c + ** C unit test to cover a probabilistic splay tree library implementation. + ** These tree data structures are used as key-value store in several of the + ** management facilities of the backend + ** @see psplay.h */ diff --git a/tests/library/c-lib/test-safeclib.c b/tests/library/c-lib/test-safeclib.c index 6de98c184..c0f80d10f 100644 --- a/tests/library/c-lib/test-safeclib.c +++ b/tests/library/c-lib/test-safeclib.c @@ -20,8 +20,9 @@ * *****************************************************/ -/** @file §§§ - ** unit test §§TODO§§ +/** @file test-safeclib.c + ** C unit test to cover size checked C operations + ** @see safeclib.h */ diff --git a/tests/library/c-lib/test-slist.c b/tests/library/c-lib/test-slist.c index 296a3ca8b..4d34f9fd4 100644 --- a/tests/library/c-lib/test-slist.c +++ b/tests/library/c-lib/test-slist.c @@ -20,8 +20,8 @@ * *****************************************************/ -/** @file §§§ - ** unit test §§TODO§§ +/** @file test-slist.c + ** C unit test to cover a single linked list library implementation */ diff --git a/tests/library/c-lib/test-time.c b/tests/library/c-lib/test-time.c index ac31b798c..09f3e4589 100644 --- a/tests/library/c-lib/test-time.c +++ b/tests/library/c-lib/test-time.c @@ -20,8 +20,11 @@ * *****************************************************/ -/** @file §§§ - ** unit test §§TODO§§ +/** @file test-time.c + ** C unit test to cover the basic low-level time handling operations + ** @see time.h + ** @see timevalue.hpp + ** @see TimeValue_test high-level time entities */ diff --git a/tests/library/meta/dummy-functions.hpp b/tests/library/meta/dummy-functions.hpp index 7cf523e4d..0b776236e 100644 --- a/tests/library/meta/dummy-functions.hpp +++ b/tests/library/meta/dummy-functions.hpp @@ -21,7 +21,7 @@ * *****************************************************/ /** @file dummy-functions.hpp - ** unit test §§TODO§§ + ** dummy functions to support unit testing of function metaprogramming helpers */