From: Amos Jeffries <squid3@treenet.co.nz>
Date: Sun, 3 May 2009 07:07:07 +0000 (+1200)
Subject: Auto-Docs: Add \cpptest directive
X-Git-Tag: SQUID_3_2_0_1~1025
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=7d8b1af2fc80ae1b0890822adebbdb1250ec4aef;p=thirdparty%2Fsquid.git

Auto-Docs: Add \cpptest directive

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

diff --git a/squid3.dox b/squid3.dox
index 8c95bbf0e5..647255503d 100644
--- a/squid3.dox
+++ b/squid3.dox
@@ -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.