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
2017-02-22 03:46:23 +01:00 · 2017-02-22 03:46:23 +01:00 · b4e0f6bf40
commit b4e0f6bf40
parent 155bf95ce5
20 changed files with 73 additions and 41 deletions
--- 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 <ct@pipapo.org>
@ -20,8 +20,9 @@

 * *****************************************************/

-/** @file §§§
- ** unit test §§TODO§§
+/** @file test-filedescriptors.c
+ ** C unit test to cover filedescriptor management
+ ** @see filedescriptor.h
 */


--- 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
 */


--- 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
 */


--- 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 <ct@pipapo.org>
@ -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
 */


--- 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
 */


--- 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
 */


--- 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
 */


--- 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
 */


--- 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
 */


--- 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.
 */


--- 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
 */


--- 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
 */


--- 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
 */


--- 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
 */


--- 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
 */


--- 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
 */


--- 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
 */


--- 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
 */


--- 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
 */


--- 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
 */