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

c++ output doxygen
ThomasMcLeod picture ThomasMcLeod · Apr 9, 2016 · Viewed 28.6k times · Source

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?

Answer

Thomas Matthews picture Thomas Matthews · Apr 9, 2016

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.

Related questions

How to print out the contents of a vector?

I want to print out the contents of a vector in C++, here is what I have: #include <iostream> #include <fstream> #include <string> #include <cmath> #include <vector> #include <sstream&…

Read More
CMake output/build directory

I'm pretty new to CMake, and read a few tutorials on how to use it, and wrote some complicated 50 lines of CMake script in order to make a program for 3 different compilers. This probably concludes all my knowledge in CMake. …

Read More
What does flushing the buffer mean?

I am learning C++ and I found something that I can't understand: Output buffers can be explicitly flushed to force the buffer to be written. By default, reading cin flushes cout; cout is also flushed when the program ends normally. …

Read More