let's do docs.

Ian Monroe ian at monroe.nu
Mon Mar 19 19:51:57 CET 2007


On 3/19/07, Alexandre Oliveira <aleprjlists at gmail.com> wrote:
> if it's not, write a small description for the class, and document
> only the not so obvious methods, explaining why they're necessary, and
> why they do something not so obvious.

Yea I agree with this. When I think about what documentation I wished
I had from browsing Amarok source it would often be at the broader
class or system level, giving an overview of how the class operates.
This is the sort of thing that might become out of date... but knowing
how the class used to operate can also be useful. So just date things.
;)

Ian Monroe


More information about the Amarok-devel mailing list