Log in

View Full Version : Automated Documentation


adinobro
06-15-2003, 12:15 PM
I don't know if any of you have worked with doxygen before (similar to javadoc) but I thought I'd run eqemu through it.

I'm going to try and start documenting eqemu based on it's coding standards so the documentation can be generated automatically.

Here's the manual if you can to use some of the mark up commands (if you use the java doc ones you should be fine)
http://www.stack.nl/~dimitri/doxygen/manual.html

Here's what I've generated:
http://www.msincome.com/eqemu/doc/html/
(This is a temporary location and will be moving soonish)

Anyway if you have any area's that you think should be documented first? Or an order that you'd like me to do then post and I'll try to do them in order.

I'll probably add a cvsweb interface when I get around to it as well.
http://stud.fh-heilbronn.de/~zeller/cgi/cvsweb.cgi/

Any comments are welcome.

Trumpcard
06-15-2003, 02:44 PM
I use javadocs all the time where I work, and I had heard about doxygen, but never used it.

Looks to be very handy!