HLP Network

News:

HLP Donations Page has been reworked for supporting the site.
Please note that the previous "Tiers" are currently not operational (but will be worked on).
You can still cancel any previous re-occurring donations to make new ones which will go to the new Treasurer Admin (Zacam).

 
« Previous Thread Next Thread »
Print
Pages: [1]   Go Down

Author Topic: Doxygen  (Read 2456 times)

0 Members and 1 Guest are viewing this topic.

Offline Inquisitor

Doxygen
on: May 08, 2002, 02:06:38 pm
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?
No signature.
 

Offline Mysterial

  • 25
    • http://www.error691.com/mysterial
Doxygen
Reply #1 on: May 08, 2002, 02:59:27 pm
"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.
  

Offline Sandwich

  • Got Screen?
  • 213
    • Skype
    • Steam
    • Twitter
    • Brainzipper
Re: Doxygen
Reply #2 on: May 08, 2002, 03:06:56 pm
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?


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?
SERIOUSLY...! | {The Sandvich Bar} - Rhino-FS2 Tutorial | CapShip Turret Upgrade | The Complete FS2 Ship List | System Background Package

"...The quintessential quality of our age is that of dreams coming true. Just think of it. For centuries we have dreamt of flying; recently we made that come true: we have always hankered for speed; now we have speeds greater than we can stand: we wanted to speak to far parts of the Earth; we can: we wanted to explore the sea bottom; we have: and so  on, and so on: and, too, we wanted the power to smash our enemies utterly; we have it. If we had truly wanted peace, we should have had that as well. But true peace has never been one of the genuine dreams - we have got little further than preaching against war in order to appease our consciences. The truly wishful dreams, the many-minded dreams are now irresistible - they become facts." - 'The Outward Urge' by John Wyndham

"The very essence of tolerance rests on the fact that we have to be intolerant of intolerance. Stretching right back to Kant, through the Frankfurt School and up to today, liberalism means that we can do anything we like as long as we don't hurt others. This means that if we are tolerant of others' intolerance - especially when that intolerance is a call for genocide - then all we are doing is allowing that intolerance to flourish, and allowing the violence that will spring from that intolerance to continue unabated." - Bren Carlill
 

Offline penguin

  • Eudyptes codus
  • 28
  • Still alive.
Doxygen
Reply #3 on: May 08, 2002, 03:32:17 pm
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)
your source code slave
 

Offline EdrickV

  • Valued
  • 29
    • http://members.aol.com/HunterComputers
Doxygen
Reply #4 on: May 10, 2002, 01:40:39 am
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.
Ground - "Let me help you out, you're clear to taxi any way you can, to any runway you see."

Mesh Gallery/Downloads:
http://members.aol.com/ArisKalzar/Gallery.html
Turreting 101:
http://members.aol.com/EdrickV/FS2/Turreting.html

http://members.aol.com/HunterComputers
Print
Pages: [1]   Go Up
« Previous Thread Next Thread »