什么时候在Doxygen中使用[in] vs [in,out]和struct params

时间:2015-01-06 19:31:19

标签: c doxygen

以下是Doxygen中[in]或[in,out]参数的示例吗?我有一个指向我传递给函数的结构的指针。该函数将修改结构的一部分,但不是全部。

另外,如果我返回相同的结构指针以使我能够进行函数链接怎么办?在这种情况下,我仍在修改输入参数的一部分,但我也返回它。

2 个答案:

答案 0 :(得分:2)

您的示例是[in,out]的案例。你取struct(通过指针),在函数返回后,struct不再像以前一样了。您不修改所有内容并且它保留在同一位置这一事实无关紧要。如果您的函数具有修改对象的副作用,则它是一个超出参数。

返回指向对象的指针这一事实对您接受作为参数的对象的修改没有影响。

答案 1 :(得分:1)

const struct bla *x

[in]参数

struct bla *x

[in,out]参数