project-navigation
Personal tools

Author Topic: Doxygen  (Read 7757 times)

Offline Destructavator

  • Combination Multiple Specialty Developer
  • Administrator
  • PHALANX Commander
  • *****
  • Posts: 1908
  • Creater of Scorchcrafter, knows the zarakites...
    • View Profile
Doxygen
« on: August 10, 2009, 05:33:33 pm »
Quote
BTW, is there an API documentation somewhere of the modified graphics engine?

Never mind, I figured it out after some research - This Doxygen program is quite impressive.

If anyone is interested, I've put together two uploads of the source docs for any potential coders to look at, it includes some coding TODOs although before anyone starts coding away I'd suggest making sure you're not coding something someone else is already working on.

HTML format (all platforms, open "index.html" with an internet browser):

http://www.destructavator.com/92dl/html-r25606.zip

Windows CHM help-file format (all in one file, Windows users can simply click on the file to open it, other platforms might need 3rd party viewers):

http://www.destructavator.com/92dl/UFOai_r25606.zip

I probably should have named that last link differently, please don't confuse it with a binary installer.

Both links are roughly ~17 MB in size.

Offline Mattn

  • Administrator
  • PHALANX Commander
  • *****
  • Posts: 4831
  • https://github.com/mgerhardy/vengi
    • View Profile
    • Vengi Voxel Tools
Re: Doxygen
« Reply #1 on: August 11, 2009, 12:26:28 am »
hopefully Zenerka will have a online copy online soon. we were talking about this a few days ago and he suggested to install a cron job that is updating from time to time. an up-to-date doxygen docu would be quite cool.

Offline Zenerka

  • Sergeant
  • *****
  • Posts: 301
    • View Profile
Re: Doxygen
« Reply #2 on: August 11, 2009, 09:37:07 pm »
Yeah, when I will have time, I will do this. But if anyone else wants to do this, providing stable and reliable http:// source for daily-generated doxygen for trunk, be my guest.  :)

Offline Destructavator

  • Combination Multiple Specialty Developer
  • Administrator
  • PHALANX Commander
  • *****
  • Posts: 1908
  • Creater of Scorchcrafter, knows the zarakites...
    • View Profile
Re: Doxygen
« Reply #3 on: August 12, 2009, 03:16:11 am »
I'd be willing to upload them periodically, although I can't promise they would be daily - though because of the smaller size it should be much easier than trying to upload binary installers of the whole game - I'll let Odie take care of that, as he's been doing a good job with the binary installers.

odie

  • Guest
Re: Doxygen
« Reply #4 on: August 19, 2009, 10:01:15 am »
I'd be willing to upload them periodically, although I can't promise they would be daily - though because of the smaller size it should be much easier than trying to upload binary installers of the whole game - I'll let Odie take care of that, as he's been doing a good job with the binary installers.

Hehe, thanks Destructavator for compliments.

Back to recent issues, could u take a look at my other post regarding my recentmost abt compiling issues..... Do advise or pm me ok? Thanks. :D

Offline Zenerka

  • Sergeant
  • *****
  • Posts: 301
    • View Profile
Re: Doxygen
« Reply #5 on: September 09, 2009, 01:47:33 pm »
http://ufoai.ninex.info/doxygen/ has (at least) daily-generated doxygen, based on trunk. Happy using!  ;D

Offline Destructavator

  • Combination Multiple Specialty Developer
  • Administrator
  • PHALANX Commander
  • *****
  • Posts: 1908
  • Creater of Scorchcrafter, knows the zarakites...
    • View Profile
Re: Doxygen
« Reply #6 on: September 09, 2009, 04:14:05 pm »
http://ufoai.ninex.info/doxygen/ has (at least) daily-generated doxygen, based on trunk. Happy using!  ;D

All right!   :D

One less thing I have to worry about for myself, so I can focus on other contributions...

(I actually just got a 404 error with that link, I'd imagine in a day or two that should change as this was just posted...)

Offline Zenerka

  • Sergeant
  • *****
  • Posts: 301
    • View Profile
Re: Doxygen
« Reply #7 on: September 10, 2009, 10:16:23 am »
Fixed  :) If http://ufoai.ninex.info/doxygen/ fails for some reason, the same content is under http://ufoai.killlfile.pl/doxygen/

Offline Destructavator

  • Combination Multiple Specialty Developer
  • Administrator
  • PHALANX Commander
  • *****
  • Posts: 1908
  • Creater of Scorchcrafter, knows the zarakites...
    • View Profile
Re: Doxygen
« Reply #8 on: September 10, 2009, 04:52:31 pm »
Yes, it works now.   ;D

Quick question: Is there a way to download the whole thing to view offline?  Not a real big deal, just curious.

Offline Zenerka

  • Sergeant
  • *****
  • Posts: 301
    • View Profile
Re: Doxygen
« Reply #9 on: September 10, 2009, 07:14:50 pm »
No (except mirroring it with wget, for example), but if you want and mattn will agree, I can provide tar from the whole stuff.

Offline Destructavator

  • Combination Multiple Specialty Developer
  • Administrator
  • PHALANX Commander
  • *****
  • Posts: 1908
  • Creater of Scorchcrafter, knows the zarakites...
    • View Profile
Re: Doxygen
« Reply #10 on: September 11, 2009, 02:05:03 am »
Unless implementing an off-line download would be easy or without too much work, I wouldn't push for it, unless other people speak up and really want it.  If it would take substantial work and not very many people want it then it probably wouldn't be worth it, and it would be better to leave it on-line as it is.

Just my personal viewpoint, although Mattn would of course make such a decision.

Myself I don't have a problem using the on-line version, but for passing around test binary installers I'd think it would be nice to include such files with the source code in the installers.  That way if someone downloads test installer revision "X" and finds an issue that hasn't yet been fixed in the SVN, they have all that they need included to submit a patch.