Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Not recognizing function parameters and returns #117

Closed
cdgramos opened this issue Feb 21, 2016 · 2 comments
Closed

Not recognizing function parameters and returns #117

cdgramos opened this issue Feb 21, 2016 · 2 comments

Comments

@cdgramos
Copy link

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):

  • @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".
    

I'm doing something wrong? :x

I'm using Ubuntu 14.04. Thanks!

@jessevdk
Copy link
Owner

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
Copy link
Author

Oh wow. Everything works fine now.

It was related with the space around the *.

Thanks!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants