arianne-devel

[Arianne-devel] Stendhal/Marauroa Doxygen documentaion

[Martin F. <mar...@gm...>]

Hello,

I generated online source code documentation for the projects Stendhal and Marauaroa by using Doxygen and put it on the net:

http://shell.franken.de/~sky/stendhal/
http://shell.franken.de/~sky/marauroa/

What do you think about this? If you find it useful, I may setup a cronjob to update it ever day after any source code change. I configured the Doxygen options so to create quite much information including call graphs, caller graphs and inlined source. I can disable some of this options if you think it's not needed or to make it more readable.

Regards,

    Martin

Re: [Arianne-devel] Stendhal/Marauroa Doxygen documentaion

[Miguel A. B. L. <mig...@gm...>]

2007/11/4, Martin Fuchs <mar...@gm...>:
>
> Hello,
>
> I generated online source code documentation for the projects Stendhal and
> Marauaroa by using Doxygen and put it on the net:
>
> http://shell.franken.de/~sky/stendhal/
> http://shell.franken.de/~sky/marauroa/
>
> What do you think about this? If you find it useful, I may setup a cronjob
> to update it ever day after any source code change. I configured the Doxygen
> options so to create quite much information including call graphs, caller
> graphs and inlined source. I can disable some of this options if you think
> it's not needed or to make it more readable.



I have never been friend of placing that kind of things online as they are
not really helpful in my honest opinion.
It may make sense to add it for Marauroa, but most of the times the javadocs
are not complete and you need to refer to source code ( speaking of my
personal experience ). When that happens I have tried to update the javadoc.

Anyway, feel free to place them online if you wish.

Regards,
Miguel

Re: [Arianne-devel] Stendhal/Marauroa Doxygen documentaion

[Martin F. <mar...@gm...>]

On 07.11.2007 12:40:24 Miguel Angel Blanch Lardin wrote:
> I have never been friend of placing that kind of things online as they are
> not really helpful in my honest opinion.
> It may make sense to add it for Marauroa, but most of the times the javadocs
> are not complete and you need to refer to source code ( speaking of my
> personal experience ). When that happens I have tried to update the javadoc.

> Anyway, feel free to place them online if you wish.

Well I configured Doxygen to parse the source code and output information regardless of existing JavaDoc comments, and the source is inlined into the HTML pages, so you can find information about any function.
But personally I also tend to use Eclipse's "find reference" and "find in source" features if digging in source code. The main reason for such a documentation is, it looks quite pretty and can be used to say "Look here - there is documentation about all and anything!". So yes, you are right: If there is none of the developer being used to work with that kind of documentation, the usefulness is questionable and it may not be worth that 100 MB web space.

Regards,

   Martin