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

c++ output doxygen

33,254

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.

33,254

Author by

ThomasMcLeod

I am a systems-level SDE with mathematics and electrical engineering background, passion for rigorous analysis and precise coding in Modern C++ (11/14/17), and a focus on algorithmic correctness, and system performance. I strive to maximize software value by designing maintainable and robust code that actively addresses software entropy and reduces technical debt. Special Competencies: Mathematical modeling, numerical methods, scientific computation Data architecture, relational data modeling, object-relational mapping Devices, sensors, instruments, firmware, electrical & FPGA design, infrared communications Aspirational: computer vision, machine learning, database internals

Updated on March 08, 2020

Comments

ThomasMcLeod over 4 years
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?