dev builds
themes manual
device status forums
mailing lists
IRC bugs
dev guide

Rockbox mail archive

Subject: Re: API documentation

Re: API documentation

From: Amaury Pouly <>
Date: Wed, 8 Dec 2010 18:48:38 +0100

> I found rockbox project lacking heavily in API documentation area.
> This is major barrier for new developers.

Agree, I think some areas would benefit from it.

> Maybe we should try to use
> some semi automatic tool for this like doxygen. Of course this doesn't
> solve the problem automagically as Mr.Someone still have to write
> doxygen comments but I think it is more natural for programmers to
> write formalized comment than to document code change by other means
> (wiki, separate text file, etc.).
As I said it in the wiki, I think it's a good idea, as long as everyone does
it. Of course, there is the problem of outdated comments but if the job
properly done, it shouldn't happen.
Received on 2010-12-08

Page template was last modified "Tue Sep 7 00:00:02 2021" The Rockbox Crew -- Privacy Policy