The International Simutrans Forum

Development => Technical Documentation => Topic started by: BerndA on January 09, 2011, 03:38:24 PM

Title: Doxygen - documentation of classes etc. for developers
Post by: BerndA on January 09, 2011, 03:38:24 PM
Hi,
is something like the attached picture already established or planned? Doxygen provides helpful lists based on the source code mainly for developers.

If the developers find it useful (well, I do), I could
- create the documentation once a day
- upload it to your central server or a sourceforge server

Feedback and suggestions are welcome :-)
Title: Re: Doxygen - documentation of classes etc. for developers
Post by: inkelyad on January 09, 2011, 04:45:30 PM
It is not hard to run Doxygen.
But If can translate/put Doxygen markup in code, it will be very useful.
Title: Re: Doxygen - documentation of classes etc. for developers
Post by: prissi on January 09, 2011, 06:59:29 PM
Actually most developer use MSVC which is much better, as it instandtaniously updates cross references and the such. However, it is of course possible to run doxygen - but unfourtunately the servers I have access to either cannot run binary programs or cannot run cronjobs ...
Title: Re: Doxygen - documentation of classes etc. for developers
Post by: BerndA on January 09, 2011, 09:17:25 PM
I'm using Linux most of the time, so there's no MSVC. Actually, I'm not using any IDE currently. If public access to such documentation is appreciated, I can setup a cronjob, but how can I transfer the files to the webserver? Can you offer rsync/ssh access or something similar?
Title: Re: Doxygen - documentation of classes etc. for developers
Post by: prissi on January 09, 2011, 09:55:48 PM
Without shell rsync is rather irrealistic ... The curretn webspace is not with shell support (apart from the physik server, which I am not allowed for private hosting ...
Title: Re: Doxygen - documentation of classes etc. for developers
Post by: inkelyad on January 09, 2011, 10:44:08 PM
Quote from: BerndA on January 09, 2011, 09:17:25 PM
I'm using Linux most of the time, so there's no MSVC. Actually, I'm not using any IDE currently. If public access to such documentation is appreciated,
It easy to run Doxygen on local machine. Why do you need it somewhere in the Net?
Title: Re: Doxygen - documentation of classes etc. for developers
Post by: sdog on January 10, 2011, 05:44:23 AM
It works with Fortran and is capable of Latex!

i think i will need to have a good look into it.
Title: Re: Doxygen - documentation of classes etc. for developers
Post by: Dwachs on January 10, 2011, 02:04:28 PM
@sdog: I smell a mathematician here ...
Title: Re: Doxygen - documentation of classes etc. for developers
Post by: sdog on January 10, 2011, 06:33:41 PM
I'm afraid of mathematicians!
It's physics, so i fit much better into the crowd on this forum :-)
Title: Re: Doxygen - documentation of classes etc. for developers
Post by: Combuijs on January 10, 2011, 06:50:02 PM
QuoteI'm afraid of mathematicians!

;D  BOO!   ;D
Title: Re: Doxygen - documentation of classes etc. for developers
Post by: BerndA on January 10, 2011, 08:09:20 PM
Quote from: prissi on January 09, 2011, 09:55:48 PM
Without shell rsync is rather irrealistic ... The curretn webspace is not with shell support (apart from the physik server, which I am not allowed for private hosting ...

Maybe there could be a dedicated FTP user?
Title: Re: Doxygen - documentation of classes etc. for developers
Post by: BerndA on January 10, 2011, 08:18:29 PM
Quote from: sdog on January 10, 2011, 05:44:23 AM
i think i will need to have a good look into it.

I've used the attached control file, generating only html output.
Title: Re: Doxygen - documentation of classes etc. for developers
Post by: prissi on January 10, 2011, 09:57:04 PM
ftp use or php or python is no problem; just no shell access.