Doxygen: prepare all unit tests for inclusion in the documentation

Doxygen will only process files with a @file documentation comment.
Up to now, none of our test code has such a comment, preventing the
cross-links to unit tests from working.

This is unfortunate, since unit tests, and even the code comments there,
can be considered as the most useful form of technical documentation.
Thus I'll start an initiative to fill in those missing comments automatically
This commit is contained in:
Fischlurch 2017-02-22 01:54:20 +01:00
parent df46c3f901
commit 24b3bec4be
229 changed files with 440 additions and 440 deletions

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file sync-classlock-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file sync-locking-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file sync-timedwait-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file sync-waiting-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -21,7 +21,7 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file §§§
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -21,7 +21,7 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file §§§
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -21,7 +21,7 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file §§§
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -21,7 +21,7 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file §§§
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -21,7 +21,7 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file §§§
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -21,7 +21,7 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file §§§
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -21,7 +21,7 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file §§§
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file thread-local-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file thread-wrapper-join-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file thread-wrapper-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file diagnostic-context-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file streamtypebasicstest.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file streamtypelifecycletest.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
*/ */
/** @file §§§ /** @file teststreamtypes.hpp
** unit test TODO §§§ ** Unit test helper to create fake streamtype information
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file digxel-configurations-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file digxel-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file format-support-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file quantiser-basics-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file time-basics-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file time-control-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file time-formats-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file time-mutation-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file time-parsing-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file time-quantisation-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file time-value-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file visitingtool-extended-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file visitingtool-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file subsystem-runner-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -22,7 +22,7 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file §§§
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -21,7 +21,7 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file §§§
** unit test TODO §§§ ** unit test §§TODO§§
*/ */
@ -32,7 +32,7 @@
#include "common/config-interface.h" #include "common/config-interface.h"
#include "lib/test/test.h" #include "lib/test/test.h"
#include "interface/say_hello.h" #include "interface/say-hello.h"
/* /*
define 2 example interfaces define 2 example interfaces

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file dummy-job.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
*/ */
/** @file §§§ /** @file dummy-job.hpp
** unit test TODO §§§ ** Unit test helper to generate dummy render jobs
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file job-hash-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file scheduler-interface-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file media-access-mock-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file asset-category-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file basicpipetest.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file compoundmediatest.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file create-asset-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file deleteassettest.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file dependent-assets-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file entry-id-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file identityofassetstest.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file makecliptest.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file mediastructurequerytest.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file time-grid-basics-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file orderingofassetstest.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file typed-id-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file argument-tuple-accept-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file command-argument-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file command-basic-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file command-binding-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file command-clone-builder-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file command-equality-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file command-message-binding-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file command-mutation-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file command-registry-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file command-use1-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file command-use2-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file command-use3-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file handling-pattern-basics-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file handling-pattern-standard-impl-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file memento-tie-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file test-dummy-commands.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file buff-table-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file buffer-metadata-key-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file buffer-metadata-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file buffer-provider-protocol-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file calc-stream-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file dispatcher-interface-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file engine-interface-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file node-basic-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file node-fabrication-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file node-operation-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file node-source-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file testframe-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file tracking-heap-block-provider-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file buildertooltest.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file buildsegmenttest.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file fixture-change-detector-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file model-port-registry-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file segmentation-datastructure-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file rendersegmenttest.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file mobject-interface-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file mobject-ref-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file output-mapping-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file placement-basic-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file placement-hierarchy-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file placement-object-identity-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file placement-ref-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file addcliptest.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file defs-manager-impl-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file defs-manager-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file defs-registry-impl-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file deletecliptest.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

View file

@ -20,8 +20,8 @@
* *****************************************************/ * *****************************************************/
/** @file §§§ /** @file placement-index-query-test.cpp
** unit test TODO §§§ ** unit test §§TODO§§
*/ */

Some files were not shown because too many files have changed in this diff Show more