Help with documenting Rom 2.4b

It has been ages since I was on here last, and its glad to see things are still going, but enough of that.

I'm trying to work some on a MUD, and having looked over a few codebases, ROM seems to be the best (and one of the smaller ones at 43k lines of code I think) for a start, but right now I'm looking at documenting and commenting the code extensively to make my life a little easier.

Can anyone make some suggestions as to the easiest way to do this, or know of a source where it is already documented?

I'd use Doxygen or NaturalDocs. Doxygen It's a pain to set up the first time, but it lets you add comments somewhat naturally and generates nifty HTML output.

NaturalDocs has more natural syntax, and its output is much prettier but it isn't quite as mature or powerful as Doxygen.

www.doxygen.org
www.naturaldocs.org

I have never really used either of those before. What I have been doing is documenting the source code itself via comments and such.

On a sidenote: It seems like NaturalDocs uses an insecure system for many files it uses, making them world-writable.

Just letting you know.

Mine are neither group nor world writable. It's possible that it inherits permissions from the current directory's settings.

In any case, the nice thing about these systems is that they generate documentation automatically from comments you write for functions, structures and classes. They won't handle inline commenting, though, but arguably you don't need that if you're looking for high-level documentation of the program's structure.

I ran doxygen earlier (after I installed it), and went through the docs.

It seems it might do what I want it to. Thanks.