Author Topic: Doxygen config file for Mudlib  (Read 2221 times)

Offline Wildcat

  • Acquaintance
  • *
  • Posts: 2
    • View Profile
Doxygen config file for Mudlib
« on: May 17, 2010, 06:03:23 PM »
Does anyone have a Doxygen config file that they're willing to share?  I've been starting to work on one but given the assumption that LPC has that each file is a unique object while Doxygen tends to work on keywords within the files to define objects it's been slow going.  I'm curious if anyone has any neat tricks that they've done with Doxygen...

Offline Hilapdatus

  • Acquaintance
  • *
  • Posts: 11
    • View Profile
    • Dreamverse Support Site
Re: Doxygen config file for Mudlib
« Reply #1 on: March 02, 2014, 11:51:48 PM »
I realize this is an old post but I was just about to re-start my Doxygenation.

I added this to the top of all my LPC files:

Code: [Select]
#ifdef DOXYGEN
struct <name> : <inherited>* {
#endif

where
  • <name> is the name of the object
  • <inherited>* is comma-delimited list of files that the object inherits.
and a similar block to the bottom with a closing curly bracket.  In my doxygen config I have it #define that DOXYGEN macro, can't remember if that is standard behavior or not.

It isn't pretty but it works well.

Code: [Select]
#ifdef DOXYGEN
struct car : vehicle {
#endif

inherit LIB_VEHICLE;

protected void create()
{
  vehicle::create();
  ...
}
...

#ifdef DOXYGEN
}
#endif