Vega Strike Forums

Hi !

As i am taking the train for programming in the Vega strike environment , i have found useful to compile a doc of
the actual vegastrike-src-0.5.1.r1 source code .

I have the doc in my dropbox , and i share with you the index here :
https://www.dropbox.com/s/jb46a58c5tu4gie/index.html

A better exemple here with a list of all the classes :
https://www.dropbox.com/s/51zjzptovep7xeq/classes.html

This is useful because even if the code is not commented , all the class hierarchy is described , with links to the source files .
Yeah , it's a Doxygen generated html doc ...

A cool thing would be that this doc will be accessible via the wiki for exemple ?
( a strategic place could be here : http://wiki.vega-strike.org/DOCs )
When someone has a specific idea , the doc is there , giving to everyone a way to examine how to achieve the goal or just
argument .
And i think it's a good thing to share the same information , for a better understanding .

The OGRE3D community use it for exemple :
http://www.ogre3d.org/docs/api/1.9/

I don't know how long the folder will exist in my dropbox , so perhaps you could consider to host a doc like this in your server ?
( if you finally find that it's a good idea of course ) .

Edit :
mmm... the links i provided point to a download of a single file, in a result the full doc won't be browsable .

SO HERE IS THE ALL DOC ( 25 mega ):
https://www.dropbox.com/sh/96p8y63u3w8q6ka/mIt-ccYNue
My goal is to provide a doc online , but i actually don't own a http server .
Someone ?

Currently, the main sourcecode docs are comments to patches and the annotated list of confvars.
Seriously, though, this stuff says a lot.

Nice. We could certainly add this to the site. It would be nice if it was automatically updated too, but for now manual updating will have to do.

Thank you TbeHolder for the link !


Hi Klauss .

It would be nice if it was automatically updated too, but for now manual updating will have to do.

Yes , i think that someone in the dev team could be assigned with that task ( to make the doc for each release ) .
And someone else in charge of the wiki could then put the doc online ?
I'm glad that you've find that idea nice , that's promising for the future recruitment of devs .


Automatically updated ? mmm... you know a way to achieve that ?
I will search a bit .

ezee wrote:Automatically updated ? mmm... you know a way to achieve that ?
I will search a bit .

Just a cron somewhere, that checks for commits, and if any, rebuilds the docs and rsyncs to the webserver. Simple to set up, if one has a machine always-on to do that.

And someone else in charge of the wiki could then put the doc online ?

Nothing is stopping you as all that is needed is a forum account for edit rights After all what use is a wiki if it can't be edited by users.

Enjoy the Choice

Nothing is stopping you as all that is needed is a forum account for edit rights

ah ah ah , sure !
But my skill is actually limited to c++ code ( i'm a noob with php , never tried to edit a wiki , etc ... )
Well , i like to learn new things so why not ?
Thank you for allow me to apply my ideas !

But ... The doc is a big folder . ( 25 megas with .html and latex - i can remove the latex part )
Can i upload the folder via a ftp ? ANd where ?
Then i could just add a link in the wiki to the index of the .html tree .

Do You know a better way ?


Edit : Okay , i added a line in the wiki , but that is all i can do for now :
http://wiki.vega-strike.org/DOCs

I think the link should point to a page dedicated to the actual release version ,
with a direct link to the index of the html doc ( hosted where ? )

It really should be hosted on our sever but I don't have access www2 is the prime maintainer of our domain pheonixstorm and klauss also have the sever pw so a PM to ether of them should do the trick for setting things up like ftp access for you or watt ever works.

Enjoy the Choice

Thank you Loki .
I have finally used my personal space to upload the doc .
http://wiki.vega-strike.org/DOXYGEN_DOCUMENTATION
You are free buddies to host the doc ( to secure the thing just in in case ) and change the link in the wiki .
WE HAVE A DEV DOC ONLINE GUYS !


PS : This is a very basic doc ( but very cool too , try the search box ...), i don't master DOxygen .
I will try to make it better , and fill for exemple the ToDO list with updated text .
Also a brief presentation would be nice at the main page of that doc.