Amarok doxygen documentation

[Bart Cerneels]

On Thu, Jun 30, 2011 at 19:14, Lydia Pintscher <lydia at kde.org> wrote:
> On Thu, Jun 30, 2011 at 18:56, Bart Cerneels <bart.cerneels at kde.org> wrote:
>> On Thu, Jun 30, 2011 at 17:26, sandeep <sandy.8925 at gmail.com> wrote:
>>> Hi,
>>> Is the doxygen generated documentation for amarok available somewhere
>>> online? It just seems like a really useful thing for new contributors
>>> (especially the class hierarchy).
>>> Thanks,
>>> Sandeep
>>
>> It's not available AFAIK. But if published it's also important to be
>> accurate and that is not. A documentation effort probably would not be
>> a bad idea, but who has the time to do it?
>
> How much work is needed to make it useful? Documentation is really
> important for people like Sandeep.
> How far will we get if everyone does a good bit.
>

The problem is that as an application we don't publish stable API's.
Hence any documentation we write can be outdated a few weeks later and
those that do the implementation usually don't have the time to fully
document.

I would suggest, rather the full doxygen, to focus on clear class and
method naming, a little bit of explanation in the top of the files
with big important classes and perhaps a single design.txt in HACKING/
For any more I'm afraid we don't have the manpower.

Sandeep is doing the best that you can do though: read code and ask
questions. The mailing list is certainly a good way to ask questions,
our IRC channels are even better.

Bart