C++ Doxygen @param 方向参数 [in],[out],[in,out] 示例输出

声明:本页面是StackOverFlow热门问题的中英对照翻译,遵循CC BY-SA 4.0协议,如果您需要使用它,必须同样遵循CC BY-SA许可,注明原文地址和作者信息,同时你必须将它归于原作者(不是我):StackOverFlow 原文地址: http://stackoverflow.com/questions/36510851/
Warning: these are provided under cc-by-sa 4.0 license. You are free to use/share it, But you must attribute it to the original authors (not me): StackOverFlow

提示:将鼠标放在中文语句上可以显示对应的英文。显示中英文
时间:2020-08-28 14:36:50  来源:igfitidea点击:

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

c++outputdoxygen

提问by ThomasMcLeod

The optional direction argument for the @paramcommand is documented hereas one of the following:

@param命令的可选方向参数在此处记录为以下之一:

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

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

我在任何示例站点中都没有看到此信息如何出现在输出中。是否有示例说明此信息应如何出现在输出中?

回答by Thomas Matthews

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.