Re: Description Document, v.01

[Ingo Ruhnke]

"Neil Mitchell" <address@hidden> writes:

> The documentation I would most like to see is just a few lines at
> the top of each file saying what the file does (i.e. plays music),
> what it doesn't do (i.e. decide what music to play),

At least some classes have some documentation at the top.

> and what calls it (i.e. when actions are selected, to play
> background level music)

Thats the wrong way around, you have to understand the code top-down,
not bottom-up, ie you have to know that you can play sound via
Sound::PingusSound::play_sound ("yipee"), not what little details go
on under the hood and how a CL_SoundBuffer ends up in /dev/sound/dsp
or whatever. Anyway, if you need the called-by information, doxygen
provides that.

-- 
WWW:      http://pingus.seul.org/~grumbel/ 
JabberID: address@hidden 
ICQ:      59461927