Hard Light Productions Forums

Modding, Mission Design, and Coding => FS2 Open Coding - The Source Code Project (SCP) => Topic started by: Inquisitor on July 08, 2002, 10:26:34 am

Title: Doxygen Docs
Post by: Inquisitor on July 08, 2002, 10:26:34 am

I just ran Doxygen on the source, it actually came out readable.

I'll work with Thunder (and probably upload to the CVS website as well) to put this on the website(s) but if folks want to run it themselves, I believe it can be downloaded for free at doxygen.org

This creates documentation on the source code including class heirarchies, linked HTML pages in the code (leading you from function to function in the source), etc.

Some developers find this level pof documentation useful.

I'll try and keep this updated, and both an unaltered (released) copy and a copy run on our development tree after major milestones, and on the websites in the future.

It's 45 megs uncompressed HTML, FYI.

Title: Doxygen Docs
Post by: phreak on July 08, 2002, 10:35:38 am

does anyone here have 45 megs of webspace?

Title: Doxygen Docs
Post by: Inquisitor on July 08, 2002, 10:37:30 am

I think that we have it on the CVS website, I have to dash an email off to them tonight when i get home (unless they are reading :)).

Also, that's Thunder's call for the temp website space as well :)

Title: Doxygen Docs
Post by: penguin on July 08, 2002, 10:41:04 am

nifty :yes:

A nice thing to do would be to add function header comments so that doxygen can produce more legible output.  I am in favor of the javadoc syntax, since, umm well, I do java development as well.  Standards are nice :nod:

http://www.stack.nl/~dimitri/doxygen/docblocks.html

I guess any new stuff that gets added should adhere to the "officially approved" syntax, and anyone with a few spare cycles :rolleyes: can go back and fix the existing headers.

That should put an end to all the "can someone please explain the source code to me" posts... or at least we have a standard answer: RTFM :D

Title: Doxygen Docs
Post by: Inquisitor on July 08, 2002, 10:50:08 am

Yeah, lets add a standards discussion to the agenda for saturday, I tried to get at it last time, but wasn't sure how to frame it.

Title: Doxygen Docs
Post by: Inquisitor on July 11, 2002, 11:20:33 am

These are uploading now, and will be able to be accessed at:

http://fs2source.warpcore.org/dox/

I'll redo them in the format of the site at a later date (unless someone wants to do that for me) but there they are (or there they will be).

Enjoy!

Title: Doxygen Docs
Post by: EdrickV on July 11, 2002, 08:29:17 pm

How big would all the docs be in a zip file? Loading them locally would be a lot quicker then from the web. (Especially since not everyone is likely to be online while editing the source code.)

Last time I tried Doxygen on the FS2 source it crashed.

Title: Doxygen Docs
Post by: Inquisitor on July 11, 2002, 09:16:27 pm

No idea, will look tomorrow.

Maybe pop onto IRC and we can work thru the Doxygen issues?

Title: Doxygen Docs
Post by: EdrickV on July 11, 2002, 10:04:22 pm

I'm not really fond of IRC, and my Doxygen issues were probably because I was running it from Cygwin rather then a Linux box. It caused a GPF as I recall. It was a while ago. But you got it to work right so there are Doxygen docs for FS2 now anyways. :)

Title: Doxygen Docs
Post by: Inquisitor on July 12, 2002, 07:48:22 pm

Ah, there IS a windows port of it, might be friendlier to run.

And our IRC server is very newbie friendly ;)