]> git.ipfire.org Git - thirdparty/squid.git/commitdiff
Auto-Docs: Add \cpptest directive
authorAmos Jeffries <squid3@treenet.co.nz>
Sun, 3 May 2009 07:07:07 +0000 (19:07 +1200)
committerAmos Jeffries <squid3@treenet.co.nz>
Sun, 3 May 2009 07:07:07 +0000 (19:07 +1200)
This is a custom directive just for squid.
It's used by adding to the declaration documentation of a function or
class method and listing the name of a unit-test function which
tests the documented function/method. It may be used multiple times
in a single function if there are multiple unit-tests for it.
Though in general multiple unit-tests sequences should be done in one
testing function.

squid3.dox

index 8c95bbf0e5d65be646364b3ac15167f00a7672ad..647255503d448f20d2508c147b86e4a84d87a362 100644 (file)
@@ -179,7 +179,8 @@ TAB_SIZE               = 4
 # will result in a user-defined paragraph with heading "Side Effects:". 
 # You can put \n's in the value part of an alias to insert newlines.
 
-ALIASES                = "test=\par Unit-Tested by:\n"
+ALIASES                = 
+ALIASES += "cpptest=\xrefitem cpptest \"Unit Test:\" \"Unit Tests\""
 
 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C 
 # sources only. Doxygen will then generate output that is more tailored for C.