Question

每个mexFunction都有相同的原型：

void mexFunction(int nlhs, mxArray *plhs[], int nrhs, const mxArray *prhs[])

我们可以将其记录为正常函数：

void mexFunction(
    int nlhs, /**< number of left hand arguments **/
    mxArray *plhs[], /**< left hand arguments **/
    int nrhs, /**< number of right hand arguments **/
    const mxArray *prhs[] /**< right hand arguments **/
    )

但这并没有告诉我们实际的论点。

是否有更好的选择，而不仅仅是记录为：

/**
* \details
* inputs:
*    prhs[0] - blah blah
*    prhs[1] - blah 
*
* outputs:
*    plhs[0] - yadda yadda
**/

在网上找到错误的例子：

没有找到好的例子。

Answer 1

一个可能的解决方案，但子弹的语法很挑剔，输出有很多多余的空格（我可能仍然接受别人的解决方案）：

void mexFunction(
    int nlhs, /**< number of left hand arguments (3 expected) */
    mxArray *plhs[], /**< left hand arguments, expected elements:
                      *    - [0] - blah
                      *    - [1] - blah blah blah blah, blah blah blah
                                   blah blah
                      *    - [2] - yadda yadda  */
    int nrhs, /**< number of right hand arguments (0 expected) */
    const mxArray *prhs[] /**< right hand arguments (no elements expected) */
)

如何用Doxygen记录mexFunction参数？

1 个答案: