[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Gnash-dev] Source code documentation tool
From: |
Tomas Groth |
Subject: |
Re: [Gnash-dev] Source code documentation tool |
Date: |
Wed, 13 Sep 2006 14:27:35 +0200 (CEST) |
Hi,
>
> I'm currently reading through the gnash source code and writing a
> document describing the structure/workflow of the whole thing, so
> that it's easier to understand it.
>
> Now, does somebody know a nice tool that parses the source code and
> generates a abstract source code documentation? Having some HTML
> pages where I can browse through the class definitions and the
> inheritance would be of great help.
>
> Something like: "sprite_instance", derives from "character" -> click
> -> derives from "movie" -> click -> ....
>
> I could google for this but maybe you already know a good tool that
> would work well with the Gnash source code...?
>
If I remember correctly we are using doxygen, which means that comments in the
code which is started with "///" (instead og "//" will be picked up by doxygen.
And it should already pick up a great deal, take a look at (the probably
outdated) http://www.gnu.org/software/gnash/manual/doxygen/
cheers,
Tomas