3 Replies - 307 Views - Last Post: 02 July 2012 - 04:12 PM Rate Topic: -----

#1 yothsoggoth  Icon User is offline

  • New D.I.C Head
  • member icon

Reputation: 19
  • View blog
  • Posts: 49
  • Joined: 19-June 12

Doxygen ignores function

Posted 02 July 2012 - 02:32 PM

I'm trying to use Doxygen to generate some basic API docs for a small project, and I've succeeded in generating the documentation for the majority of the code, including all the classes and methods, however there are a few functions that aren't within a class, and although they have Doxygen-style comments they don't appear anywhere in the documentation.

Here's an example of the code for one of them:
/*! \brief Returns a random number between the inclusive minimum and exclusive maximum.
 * \param max The maximum value to return (exclusive)
 * \param min The minimum value to return (inclusive, defaults to 0)
 * \returns The random number generated.
 * \todo This needs to be overloaded for other data types (e.g. float and double)
 */
int Random( int max, int min = 0 );



Thanks for any responses,
Joe.

Is This A Good Question/Topic? 0
  • +

Replies To: Doxygen ignores function

#2 yothsoggoth  Icon User is offline

  • New D.I.C Head
  • member icon

Reputation: 19
  • View blog
  • Posts: 49
  • Joined: 19-June 12

Re: Doxygen ignores function

Posted 02 July 2012 - 02:45 PM

Also, I've just checked Doxygen's output and the files with these functions in are processed.

(Would've added this to the first post, but couldn't figure out how to edit, I presume there's a minimum number of posts needed before editing is allowed?)
Was This Post Helpful? 0
  • +
  • -

#3 Skydiver  Icon User is offline

  • Code herder
  • member icon

Reputation: 3491
  • View blog
  • Posts: 10,748
  • Joined: 05-May 12

Re: Doxygen ignores function

Posted 02 July 2012 - 03:00 PM

Are you using a \file or \defgroup for those global functions?

See FAQ #3: http://www.stack.nl/...oxygen/faq.html

This post has been edited by Skydiver: 02 July 2012 - 03:01 PM

Was This Post Helpful? 0
  • +
  • -

#4 yothsoggoth  Icon User is offline

  • New D.I.C Head
  • member icon

Reputation: 19
  • View blog
  • Posts: 49
  • Joined: 19-June 12

Re: Doxygen ignores function

Posted 02 July 2012 - 04:12 PM

I was using \file. I've changed it to use \defgroup and \ingroup now, and it works okay that way.

Thanks :)
Was This Post Helpful? 0
  • +
  • -

Page 1 of 1