Modding, Mission Design, and Coding > FS2 Open Coding - The Source Code Project (SCP)

Doxygen

(1/1)

Inquisitor:
Serious question from the other thread.

Anyone tried running this beast thru an automated source code documentation program?

I have never used them, but I have seen the output. Seems like a useful excercise?

Mysterial:
"automated source code documentation program"? There exists such a beast? I can't imagine such a thing actually working to any great extent. Of course, anything's possible.

Sandwich:

--- Quote ---Originally posted by Inquisitor
Serious question from the other thread.

Anyone tried running this beast thru an automated source code documentation program?

I have never used them, but I have seen the output. Seems like a useful excercise?
--- End quote ---


All right! A Serious question! Yeah, baby!! :p

Back on-topic, uhm... does that thing do what it sounds like - add comments to the code for documentation's sale? I understood that the code was quite well documented, no?

penguin:
If it's anything like javadoc (which generates documentation from java source), the code AND the comments have to be structured correctly, or what is generated is almost useless.  Not that having structured comments is a bad thing -- anything to increase readabilty is good -- it's just rather unlikely that the :v: code matches the format required.

Probably worth a shot though...  

BTW, A nice cross-ref tool would also be nice to understand who calls whom (I think MSVC can do this, I'll try it out when I get a chance)

EdrickV:
Tried Doxygen on the FS2 source. Needless to say it took forever and in the end it crashed. (Might have been a lack of virtual memory thing, getting low on HD space. Need to move some stuff to CD-Rs and get rid of some other stuff.) It may be able to get something out of it, by grabbing things like function, class, variable, etc. definitions and such, but it appears it won't grab the comments that are already in the source. (They weren't setup as Doxygen comments, and it's got some odd rules about them.) Anyone know of something better for a situation like this? If we could even grab the comments near the code they're associated with it could be useful. Will try Doxygen again later anyways.

Navigation

[0] Message Index