2015-01-15 94 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