jessevdk / cldoc

clang based documentation generator for C and C++
GNU General Public License v2.0
552 stars 58 forks source link

Not recognizing function parameters and returns #117

Closed cdgramos closed 8 years ago

cdgramos commented 8 years ago

Hey, cldoc works great but when I'm documenting parameters and return values it simply won't show it as supposed. Instead it show me the parameters and return value as a bullet list.

Example of a function I'm trying to document:

/* io_CheckH Function. @h hurst exponent value to be checked. io_CheckH verifies if a certain given number is in the range of values of the Hurst Exponent. @return "ERR" if h < 0.0 || h >= 1.0 otherwise returns "OK". */ int io_CheckH (double h);

Documentation generated (a bullet list with this points):

I'm doing something wrong? :x

I'm using Ubuntu 14.04. Thanks!

jessevdk commented 8 years ago

cldoc is strict about format and spacing. Try formatting your comment correctly (see https://github.com/jessevdk/cldoc/blob/master/example/transport/mountainbike.hh#L8 for an example).

cdgramos commented 8 years ago

Oh wow. Everything works fine now.

It was related with the space around the *.

Thanks!!