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: API documentation

Re: API documentation

From: Maurus Cuelenaere <mcuelenaere_at_gmail.com>
Date: Wed, 08 Dec 2010 20:34:13 +0100

Op 08-12-10 18:42, Marcin Bukat schreef:
> Hello rockboxers!
>
> I found rockbox project lacking heavily in API documentation area.
> This is major barrier for new developers. 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.).

I've written a plugin documentation generator for Rockbox in the past (see
utils/rockbox_api/ and FS#9802), however this was written in PHP (which not many
people have installed by default) and is incomplete.

I started rewriting this to Perl but never got to completing it. My intention
was to create some basic documentation regarding the plugin API for both C and Lua.

IIRC domonoky/bluebrother tried running Doxygen on plugin.h but never quite got
the same result as a custom-written tool.

However as this is about Rockbox in general (and not just the plugin API),
Doxygen could be a quite useful tool (provided someone starts adding inline
comments).

-- 
Maurus Cuelenaere
Received on 2010-12-08

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