Amarok API docs online

Maximilian Kossick maximilian.kossick at googlemail.com
Mon Mar 1 23:18:00 CET 2010


On Mon, Mar 1, 2010 at 10:09 PM, Kevin Funk <krf at gmx.de> wrote:
> Monday 01 March 2010, Téo Mrnjavac <teo.mrnjavac at gmail.com>:
>> On Mon, Mar 1, 2010 at 19:57, Kevin Funk <krf at gmx.de> wrote:
>> > Monday 01 March 2010, Maximilian Kossick
> <maximilian.kossick at googlemail.com>:
>> >> On Mon, Mar 1, 2010 at 7:15 PM, Mark Kretschmann <kretschmann at kde.org>
>> >
>> > wrote:
>> >> > Ahoy,
>> >> >
>> >> > Kevin Funk (krf) was so nice to run our API docs through Doxygen, and
>> >> > he put it online here:
>> >> >
>> >> > http://kollide.net/~krf/amarok-apidocs/
>> >> >
>> >> >
>> >> > It also visualizes the class hierarchies nicely, like here with our
>> >> > Meta classes:
>> >> >
>> >> > http://kollide.net/~krf/amarok-apidocs/classMeta_1_1MetaBase.html
>> >> >
>> >> >
>> >> > I find this quite handy, and maybe it might even motivate us to
>> >> > actually document our classes better ;)
>> >>
>> >> If Jeff installs doxygen on the CI server, we can have it generate the
>> >> apidocs during each incremental or nightly build
>> >
>> > Yep, saw your commit wrt doxygen support and already thought you were
>> > about to add this plugin.
>> >
>> > And just for the record, that Xvnc plugin for the CI could be pretty neat
>> > for taking screenshots after each build. Could help in comparing visual
>> > changes between two revisions.
>> >
>> > Greets
>>
>> Since I always whine about documenting one's code, and I take care to
>> document everything I do with doxygen syntax, all I can say is a big
>> KRF++
>
> I just ran doxygen and uploaded the stuff. No big deal ;)
>
>> No doubt that this will make it much easier for new contributors to
>> find their way around Amarok sources.
>
> Exactly. This is the the most important reason for doing this whole thing.
> But we have to improve the apidocs (my code isn't well documented either).
>
> Greets
>

Courtesy of your friendly Hudson server:

http://ci.amarok.kde.org/job/Amarok-Nightly/doxygen/

Automatically generated apidocs as part of the  nightly build.


More information about the Amarok-devel mailing list