Skip to main content
gamedev.net
🔒 Locked

Doxygen, automatic source code documentator: ROCKS!!

Started by owl 5 replies 1.4k views
Original Post
owl
owl
Have you tried it? You REALLY should. You give the path to your sourcefiles and it generates the full HTML (and many other) files of hyperlinked documentation. go here KDE uses it, the resulting docs look like this And it is free. Very, very cool... PD: I know this is no news for someone, but I guess there are people out there who don't know about it. As I did. [edited by - xaxa on May 8, 2003 7:17:49 PM]
[size="2"]I like the Walrus best.
acraig
acraig
Yes, doxygen is a very neat system and provides many different features. We use it own our project and it really helps to keep the documentation flowing and makes it much easier to look things up as well. We also have a cron job that runs once a day that checks out all the code from CVS, runs doxygen on it and updates the website.

-------
Andrew
PlaneShift - A MMORPG in development.
CpMan
CpMan
Doxygen is awesome..with css sheets you can do some nice things. Check ours (a little outdated).



Gamedev for learning.
libGDN for putting it all together.
An opensource, cross platform, cross API game development library.
VSEDebug Visual Studio.NET Add-In. Enhances debugging in ways never thought possible.
owl
owl
Very nice! Both ideas.
[size="2"]I like the Walrus best.
CpMan
CpMan
Never tried a cron job..wouldn''t be a big deal to do.



Gamedev for learning.
libGDN for putting it all together.
An opensource, cross platform, cross API game development library.
VSEDebug Visual Studio.NET Add-In. Enhances debugging in ways never thought possible.
JimH
JimH
I''ve used it and I think it''s great as well. But there is an improvement or two I''d like to see. I have some classes with long enum members. These get put at the top and make it harder to see more important functions that get pushed much lower on the page. Maybe there is a way to handle this better and I just haven''t figured out how yet.
owl
owl
quote:
Original post by JimH
I''ve used it and I think it''s great as well. But there is an improvement or two I''d like to see. I have some classes with long enum members. These get put at the top and make it harder to see more important functions that get pushed much lower on the page. Maybe there is a way to handle this better and I just haven''t figured out how yet.


An include file for the enums?

[size="2"]I like the Walrus best.

Topic Locked

This topic has been locked by a moderator. New replies are not allowed.

Sign in to reply to this topic.