Re: /bzr/squid3/trunk/ r9671: Auto-Docs: Add \cpptest directive

Sounds really useful, can you remember to add it to the documentation
template in the wiki (I'm in Amsterdam on a "business vacation", not
really in the condition to do it myself)

  Thanks!

  Francesco

On Sun, May 3, 2009 at 9:07 AM, Amos Jeffries <squid3_at_treenet.co.nz> wrote:
> ------------------------------------------------------------
> revno: 9671
> committer: Amos Jeffries <squid3_at_treenet.co.nz>
> branch nick: trunk
> timestamp: Sun 2009-05-03 19:07:07 +1200
> message:
>  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.
> modified:
>  squid3.dox
>
> === modified file 'squid3.dox'
> --- a/squid3.dox        2009-04-26 04:39:46 +0000
> +++ b/squid3.dox        2009-05-03 07:07:07 +0000
> @@ -179,7 +179,8 @@
>  # 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.
>
>
>

-- 
    /kinkie