You can group items and supply a single description for them.
See: http://www.stack.nl/~dimitri/doxygen/grouping.html
Note particularly the "@{" and "@{" commands.
Example: I have done simple groups within a class like this:
//! /name Triggers
//! These methods trigger things
//@{
//! Trigger to do state checking
void state_check_trigger()
//! Trigger to do event notification
void event_trigger()
//@}
The first two lines are the documentation for the group.
The middle two lines document each item in the group.
The two methods will be presented in the doxygen output as a group of items.
-----Original Message-----
From: Joel Bodenmann [mailto:[email protected]]
Sent: Wednesday, December 19, 2012 12:35 PM
To: [email protected]
Subject: [Doxygen-users] Doxygen for multiple #defines
Hello folks,
I am just wondering if it is somehow possible to create a list in the
doxygen for multiple #defines, but without having to @brief each of them
separately.
Here's an example:
/**
* @brief Some basic colors
*/
#define White HTML2COLOR(0xFFFFFF)
#define Black HTML2COLOR(0x000000)
#define Gray HTML2COLOR(0x808080)
#define Grey Gray
#define Blue HTML2COLOR(0x0000FF)
#define Red HTML2COLOR(0xFF0000)
What I would like to get now is a doxygen entry named "colors" with a
list of all these defines. Is that possible?
Kind regards,
~ Joel Bodenmann
------------------------------------------------------------------------------
LogMeIn Rescue: Anywhere, Anytime Remote support for IT. Free Trial
Remotely access PCs and mobile devices and provide instant support
Improve your efficiency, and focus on delivering more value-add services
Discover what IT Professionals Know. Rescue delivers
http://p.sf.net/sfu/logmein_12329d2d
_______________________________________________
Doxygen-users mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/doxygen-users
This email was sent to you by Thomson Reuters, the global news and information
company. Any views expressed in this message are those of the individual
sender, except where the sender specifically states them to be the views of
Thomson Reuters.
------------------------------------------------------------------------------
LogMeIn Rescue: Anywhere, Anytime Remote support for IT. Free Trial
Remotely access PCs and mobile devices and provide instant support
Improve your efficiency, and focus on delivering more value-add services
Discover what IT Professionals Know. Rescue delivers
http://p.sf.net/sfu/logmein_12329d2d
_______________________________________________
Doxygen-users mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/doxygen-users
