Amarok doxygen documentation
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 ___ Amarok-devel mailing list Amarok-devel@kde.org https://mail.kde.org/mailman/listinfo/amarok-devel
Re: Amarok doxygen documentation
On Thu, Jun 30, 2011 at 18:56, Bart Cerneels bart.cerne...@kde.org wrote: On Thu, Jun 30, 2011 at 17:26, sandeep sandy.8...@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. Cheers Lydia -- Lydia Pintscher KDE Community Working Group member http://kde.org - http://about.me/lydia.pintscher ___ Amarok-devel mailing list Amarok-devel@kde.org https://mail.kde.org/mailman/listinfo/amarok-devel
Re: Amarok doxygen documentation
On Thu, Jun 30, 2011 at 18:56, Bart Cerneels bart.cerne...@kde.org wrote: On Thu, Jun 30, 2011 at 17:26, sandeep sandy.8...@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? A discussion wrt documentation is on the agenda for our Amarok team BoF session at DS2011. Other than that, a good start would be not pushing any code that doesn't have doxygen comments before class definitions and members. That's a policy I try to follow, usually I do the bulk of the work on something and then take a few hours for an intense documentation effort before pushing/merging. -- Teo ___ Amarok-devel mailing list Amarok-devel@kde.org https://mail.kde.org/mailman/listinfo/amarok-devel
Re: Amarok doxygen documentation
On Thu, Jun 30, 2011 at 19:14, Lydia Pintscher ly...@kde.org wrote: On Thu, Jun 30, 2011 at 18:56, Bart Cerneels bart.cerne...@kde.org wrote: On Thu, Jun 30, 2011 at 17:26, sandeep sandy.8...@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 ___ Amarok-devel mailing list Amarok-devel@kde.org https://mail.kde.org/mailman/listinfo/amarok-devel
