Amarok doxygen documentation

Teo Mrnjavac teo at kde.org
Thu Jun 30 19:22:49 CEST 2011


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.

I agree, actually documentation is important for pretty much everyone
because even if you're able to figure things out, you'll figure them
out more quickly if the code is documented.
It would be cool if somebody with ack skills could do a query to find
out which headers don't have any doxygen in them, that could give us a
rough list of completely undocumented classes.
-- 
Teo


More information about the Amarok-devel mailing list