Doxygen @param direction arguments [in],[out],[in,out] example output

Question

The optional direction argument for the @param command is documented here as one of the following:

@param[in]
@param[out]
@param[in,out]

I do not see in any of the example sites how this information appears in the output. Is there an example of how this information should appear in the output?

score 24 · Answer 1 · answered Apr 08 '16 at 23:50

24

For the line:

\param[in,out] console_ptr - pointer to input from the console

I get:

Parameters
    [in,out]    console_ptr - pointer to input from the console.

answered Apr 08 '16 at 23:50

Thomas Matthews

56,849
17
98
154

Is there a page I can access? – ThomasMcLeod Apr 09 '16 at 00:53
You would need to contact the Doxygen folks or search their forums. – Thomas Matthews Apr 09 '16 at 16:31
4

An easy solution is to write a simple source file with the Doxygen comments, process it with Doxygen and see the output. – Thomas Matthews Apr 09 '16 at 16:32

Doxygen @param direction arguments [in],[out],[in,out] example output

1 Answers1