Author Topic: Doxygen - documentation of classes etc. for developers  (Read 3611 times)

0 Members and 1 Guest are viewing this topic.

BerndA

  • Guest
Doxygen - documentation of classes etc. for developers
« 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 :-)

Offline inkelyad

  • Devotees (Inactive)
  • *
  • Posts: 482
  • Total likes: 1
  • Helpful: 2
  • Languages: EN, RU
Re: Doxygen - documentation of classes etc. for developers
« Reply #1 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.

Offline prissi

  • Developer
  • Administrator
  • *
  • Posts: 8821
  • Total likes: 322
  • Helpful: 229
  • Languages: De,EN,JP
Re: Doxygen - documentation of classes etc. for developers
« Reply #2 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 ...

BerndA

  • Guest
Re: Doxygen - documentation of classes etc. for developers
« Reply #3 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?

Offline prissi

  • Developer
  • Administrator
  • *
  • Posts: 8821
  • Total likes: 322
  • Helpful: 229
  • Languages: De,EN,JP
Re: Doxygen - documentation of classes etc. for developers
« Reply #4 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 ...

Offline inkelyad

  • Devotees (Inactive)
  • *
  • Posts: 482
  • Total likes: 1
  • Helpful: 2
  • Languages: EN, RU
Re: Doxygen - documentation of classes etc. for developers
« Reply #5 on: January 09, 2011, 10:44:08 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?

Offline sdog

Re: Doxygen - documentation of classes etc. for developers
« Reply #6 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.

Offline Dwachs

  • DevTeam, Coder/patcher
  • Administrator
  • *
  • Posts: 4251
  • Total likes: 177
  • Helpful: 149
  • Languages: EN, DE, AT
Re: Doxygen - documentation of classes etc. for developers
« Reply #7 on: January 10, 2011, 02:04:28 PM »
@sdog: I smell a mathematician here ...
Parsley, sage, rosemary, and maggikraut.

Offline sdog

Re: Doxygen - documentation of classes etc. for developers
« Reply #8 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 :-)

Offline Combuijs

  • Web Team
  • Devotee
  • *
  • Posts: 1387
  • Total likes: 22
  • Helpful: 53
  • Maintainer of maps.simutrans.com
    • Combuijs
  • Languages: EN, NL
Re: Doxygen - documentation of classes etc. for developers
« Reply #9 on: January 10, 2011, 06:50:02 PM »
Quote
I'm afraid of mathematicians!

 ;D  BOO!   ;D
Bob Marley: No woman, no cry

Programmer: No user, no bugs



BerndA

  • Guest
Re: Doxygen - documentation of classes etc. for developers
« Reply #10 on: January 10, 2011, 08:09:20 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?

BerndA

  • Guest
Re: Doxygen - documentation of classes etc. for developers
« Reply #11 on: January 10, 2011, 08:18:29 PM »
i think i will need to have a good look into it.

I've used the attached control file, generating only html output.

Offline prissi

  • Developer
  • Administrator
  • *
  • Posts: 8821
  • Total likes: 322
  • Helpful: 229
  • Languages: De,EN,JP
Re: Doxygen - documentation of classes etc. for developers
« Reply #12 on: January 10, 2011, 09:57:04 PM »
ftp use or php or python is no problem; just no shell access.