Rockbox.org home
release
dev builds
extras
themes manual
wiki
device status forums
mailing lists
IRC bugs
patches
dev guide



Rockbox mail archive

Subject: Re: Plugin API documentation

Re: Plugin API documentation

From: Alex Bennee <kernel-hacker_at_bennee.com>
Date: Wed, 14 Jan 2009 09:55:22 +0000

On Wed, Jan 14, 2009 at 9:29 AM, Daniel Stenberg <daniel_at_haxx.se> wrote:
> On Wed, 14 Jan 2009, Alex Bennee wrote:
>
>> Which begs the question why not just use doxygen to generate the
>> documentation?
>
> My only gripe with doxygen is the fact that I've never yet seen a fine
> doxygen generated documentation. I think the idea is fine to get the docs
> from the source, but the presentation of that docs need to be done in a
> reading friendly way.

This may be a question of taste thing? I've used doxygen on a number
of commercial code bases and it has proved very useful. The
call-graphs and code layout are very useful for comprehending call
patterns and usage. I've never felt the need to customise the output I
get from a simple doxygen config.

The generated documentation will only ever be as good as the source
code commentary though.

>
> --
>
> / daniel.haxx.se
>

-- 
Alex, homepage: http://www.bennee.com/~alex/
CV: http://www.bennee.com/~alex/cv.php
Received on 2009-01-14

Page was last modified "Jan 10 2012" The Rockbox Crew
aaa