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
This commit is contained in:
parent
155bf95ce5
commit
b4e0f6bf40
20 changed files with 73 additions and 41 deletions
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
TEST-FILEDESCRIPTORS
|
TEST-FILEDESCRIPTORS - verify filedescriptor management
|
||||||
|
|
||||||
Copyright (C) Lumiera.org
|
Copyright (C) Lumiera.org
|
||||||
2008, Christian Thaeter <ct@pipapo.org>
|
2008, Christian Thaeter <ct@pipapo.org>
|
||||||
|
|
@ -20,8 +20,9 @@
|
||||||
|
|
||||||
* *****************************************************/
|
* *****************************************************/
|
||||||
|
|
||||||
/** @file §§§
|
/** @file test-filedescriptors.c
|
||||||
** unit test §§TODO§§
|
** C unit test to cover filedescriptor management
|
||||||
|
** @see filedescriptor.h
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -20,8 +20,9 @@
|
||||||
|
|
||||||
* *****************************************************/
|
* *****************************************************/
|
||||||
|
|
||||||
/** @file §§§
|
/** @file test-filehandles.c
|
||||||
** unit test §§TODO§§
|
** C unit test to cover management for filehandles and the filehandle cache
|
||||||
|
** @see filehandlecache.h
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -20,8 +20,9 @@
|
||||||
|
|
||||||
* *****************************************************/
|
* *****************************************************/
|
||||||
|
|
||||||
/** @file §§§
|
/** @file test-fileheader.c
|
||||||
** unit test §§TODO§§
|
** C unit test to verify file identification functions
|
||||||
|
** @see fileheader.h
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
/*
|
/*
|
||||||
TEST-FILEMAP - test file management
|
TEST-FILEMAP - test file memory mapping
|
||||||
|
|
||||||
Copyright (C) Lumiera.org
|
Copyright (C) Lumiera.org
|
||||||
2008, Christian Thaeter <ct@pipapo.org>
|
2008, Christian Thaeter <ct@pipapo.org>
|
||||||
|
|
@ -20,8 +20,9 @@
|
||||||
|
|
||||||
* *****************************************************/
|
* *****************************************************/
|
||||||
|
|
||||||
/** @file §§§
|
/** @file test-filemmap.c
|
||||||
** unit test §§TODO§§
|
** C unit test to cover memory mapping of file contents
|
||||||
|
** @see mmapings.h
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -20,8 +20,9 @@
|
||||||
|
|
||||||
* *****************************************************/
|
* *****************************************************/
|
||||||
|
|
||||||
/** @file §§§
|
/** @file test-resourcecollector.c
|
||||||
** unit test §§TODO§§
|
** C unit test to cover management of low-level resources for the backend
|
||||||
|
** @see resourcecollector.h
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -20,8 +20,8 @@
|
||||||
|
|
||||||
* *****************************************************/
|
* *****************************************************/
|
||||||
|
|
||||||
/** @file §§§
|
/** @file test-threadpool.c
|
||||||
** unit test §§TODO§§
|
** C unit test to cover our threadpool implementation
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -20,8 +20,12 @@
|
||||||
|
|
||||||
* *****************************************************/
|
* *****************************************************/
|
||||||
|
|
||||||
/** @file §§§
|
/** @file test-threads.c
|
||||||
** unit test §§TODO§§
|
** 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
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -21,8 +21,9 @@
|
||||||
|
|
||||||
* *****************************************************/
|
* *****************************************************/
|
||||||
|
|
||||||
/** @file §§§
|
/** @file test-configloader.c
|
||||||
** unit test §§TODO§§
|
** C unit test to cover a config system draft implementation
|
||||||
|
** @deprecated as of 2017 it is very likely we'll use a different approach
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -20,8 +20,10 @@
|
||||||
|
|
||||||
* *****************************************************/
|
* *****************************************************/
|
||||||
|
|
||||||
/** @file §§§
|
/** @file test-interfaces.c
|
||||||
** unit test §§TODO§§
|
** C unit test to cover the basics of our interface and plugin-loading system
|
||||||
|
** @see interface.h
|
||||||
|
** @see interfaceregistry.h
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -20,8 +20,10 @@
|
||||||
|
|
||||||
* *****************************************************/
|
* *****************************************************/
|
||||||
|
|
||||||
/** @file §§§
|
/** @file test-errorstate.c
|
||||||
** unit test §§TODO§§
|
** 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.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -20,8 +20,9 @@
|
||||||
|
|
||||||
* *****************************************************/
|
* *****************************************************/
|
||||||
|
|
||||||
/** @file §§§
|
/** @file test-llist.c
|
||||||
** unit test §§TODO§§
|
** C unit test to cover a linked list library implementation
|
||||||
|
** @see llist.h
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -20,8 +20,12 @@
|
||||||
|
|
||||||
* *****************************************************/
|
* *****************************************************/
|
||||||
|
|
||||||
/** @file §§§
|
/** @file test-locking.c
|
||||||
** unit test §§TODO§§
|
** 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
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -20,8 +20,10 @@
|
||||||
|
|
||||||
* *****************************************************/
|
* *****************************************************/
|
||||||
|
|
||||||
/** @file §§§
|
/** @file test-luid.c
|
||||||
** unit test §§TODO§§
|
** C unit test to cover generation of Lumiera Uniform Identifier hashes
|
||||||
|
** @see luid.h
|
||||||
|
** @see hash-indexed.hpp
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -20,8 +20,11 @@
|
||||||
|
|
||||||
* *****************************************************/
|
* *****************************************************/
|
||||||
|
|
||||||
/** @file §§§
|
/** @file test-mpool.c
|
||||||
** unit test §§TODO§§
|
** C unit test to cover a memory pool custom allocator
|
||||||
|
**
|
||||||
|
** @warning unfinished implementation as of 2016
|
||||||
|
** @see mpool.h
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -20,8 +20,9 @@
|
||||||
|
|
||||||
* *****************************************************/
|
* *****************************************************/
|
||||||
|
|
||||||
/** @file §§§
|
/** @file test-priqueue.c
|
||||||
** unit test §§TODO§§
|
** C unit test to cover a priority queue library implementation
|
||||||
|
** @see priqueue.h
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -20,8 +20,11 @@
|
||||||
|
|
||||||
* *****************************************************/
|
* *****************************************************/
|
||||||
|
|
||||||
/** @file §§§
|
/** @file test-psplay.c
|
||||||
** unit test §§TODO§§
|
** 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
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -20,8 +20,9 @@
|
||||||
|
|
||||||
* *****************************************************/
|
* *****************************************************/
|
||||||
|
|
||||||
/** @file §§§
|
/** @file test-safeclib.c
|
||||||
** unit test §§TODO§§
|
** C unit test to cover size checked C operations
|
||||||
|
** @see safeclib.h
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -20,8 +20,8 @@
|
||||||
|
|
||||||
* *****************************************************/
|
* *****************************************************/
|
||||||
|
|
||||||
/** @file §§§
|
/** @file test-slist.c
|
||||||
** unit test §§TODO§§
|
** C unit test to cover a single linked list library implementation
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -20,8 +20,11 @@
|
||||||
|
|
||||||
* *****************************************************/
|
* *****************************************************/
|
||||||
|
|
||||||
/** @file §§§
|
/** @file test-time.c
|
||||||
** unit test §§TODO§§
|
** 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
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -21,7 +21,7 @@
|
||||||
* *****************************************************/
|
* *****************************************************/
|
||||||
|
|
||||||
/** @file dummy-functions.hpp
|
/** @file dummy-functions.hpp
|
||||||
** unit test §§TODO§§
|
** dummy functions to support unit testing of function metaprogramming helpers
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue