Forums > Dev

Doxygen question

Mar 14 2012 | 11:58 am

Hello everybody,
I have a question about documenting the code with doxygen, and I really don’t know that to whom I should ask it.
Since I’m doing the same thing as the Max SDK commentaries, I hope that somebody here might answer (sorry if it is slightly off topic).

I followed the doxygen-comments of the cycling .h files, with @ingroup at the beginning, and some code inside the remarks (see example at bottom). But this is very badly interpreted, and the parameters are let as plain text "@param …" inside a box.
I really don’t know why it happens, and it appears to me that I do the same thing. Is there some parameter to be changed in the doxygen config file? Or what is wrong with my comment?

Thanks a lot,

And here’s an example of badly interpreted commentary (it is right before the function prototype).

/** Fill an array of type char with a list of values.
@ingroup math
@param a The pointer to the first element of the array.
@param count The number of elements to fill

@remark must be < = of the size of the array!
@remark This is just a little wrapper to avoid using multiple lines to set each single element of the array.
For instance the following code fills the array with 6 values: 0, 1, 2, 3, 4 and 5.
Functions fill_long_array(), fill_unicodeChar_array() and fill_double_array() operate in the same way.
char myarray[6];
fill_char_array(myarray, 6, 0, 1, 2, 3, 4, 5);

Viewing 1 post (of 1 total)

Forums > Dev