doxygen-users

[Doxygen-users] Using \test

[Mathieu M. <mat...@gm...>]

Hi there,

  I do not understand how am I supposed to use the \test doxygen
command. I can generate a 'testslists.txt' file which contains:

/**
\test test1.cxx
\test test2.cxx
...
*/

  The file path to those tests is specified in the EXAMPLES_PATH, I
then explicitely add this file to INPUT. But doxygen still refuses to
generate the test.html page...

What am I missing ?

Thanks,
-- 
Mathieu

Re: [Doxygen-users] Using \test

[Martin J. <mar...@is...>]

On 22.10.2008 15:22, Mathieu Malaterre wrote:
>   I do not understand how am I supposed to use the \test doxygen
> command. I can generate a 'testslists.txt' file which contains:
>
> /**
> \test test1.cxx
> \test test2.cxx
> ...
> */
>
>   The file path to those tests is specified in the EXAMPLES_PATH, I
> then explicitely add this file to INPUT. But doxygen still refuses to
> generate the test.html page...
>   
I am not sure if I understand you correctly but the argument to \test is 
a paragraph describing a test case, not a file name:

/*!
 * \test This is test case 1 for func().
 *        The description extends until the next empty line
 *        or another Doxygen command.
 */
void func()
{
}

Since \test is part of the documentation of an entity (function, class, 
etc) like \param, \return, etc, I assume that you do not get anything 
because your \test commands are not associated with any entity.

Regards
Martin Jerabek

Re: [Doxygen-users] Using \test

[Mathieu M. <mat...@gm...>]

On Wed, Oct 22, 2008 at 3:42 PM, Martin Jerabek
<mar...@is...> wrote:
> On 22.10.2008 15:22, Mathieu Malaterre wrote:
>>   I do not understand how am I supposed to use the \test doxygen
>> command. I can generate a 'testslists.txt' file which contains:
>>
>> /**
>> \test test1.cxx
>> \test test2.cxx
>> ...
>> */
>>
>>   The file path to those tests is specified in the EXAMPLES_PATH, I
>> then explicitely add this file to INPUT. But doxygen still refuses to
>> generate the test.html page...
>>
> I am not sure if I understand you correctly but the argument to \test is
> a paragraph describing a test case, not a file name:
>
> /*!
>  * \test This is test case 1 for func().
>  *        The description extends until the next empty line
>  *        or another Doxygen command.
>  */
> void func()
> {
> }
>
> Since \test is part of the documentation of an entity (function, class,
> etc) like \param, \return, etc, I assume that you do not get anything
> because your \test commands are not associated with any entity.

oooops silly me.

there is still something I need to work around. My project is as follow:

project/
   src/
   examples/
   tests/

I initially thought I would be ok with

INPUT=src
FILE_PATTERNS=*.h
EXAMPLE_PATH = examples tests
EXAMPLE_PATTERNS = *.cxx

but because of your help I now realize I need to do:

INPUT=src tests
FILE_PATTERNS=*.h *.cxx
EXAMPLE_PATH = examples
EXAMPLE_PATTERNS = *.cxx

doxygen is now harvesting a bunch of *.cxx in the 'src' directory ...
I'll see what is the impact.

thanks a bunch anyway !
-- 
Mathieu