2015-01-15 49 views
1

每个mexFunction具有相同的原型:如何使用Doxygen记录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 
**/ 

坏榜样0

没有找到好的例子。

+0

谁想出了“S”来代表“阵列”吗? – 2015-01-15 19:55:30

回答

0

一个可能的解决方案,但子弹语法是挑剔的,输出有很多多余的白色空间(我仍然可以接受别人的解决方案):

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) */ 
) 
+0

虽然更常见也许有几个右手参数和左手1 ... – 2015-01-15 19:41:51