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:12:56 +0000

On Tue, Jan 13, 2009 at 5:39 PM, Dominik Riebeling
<dominik.riebeling_at_gmail.com> wrote:
> On Tue, Jan 13, 2009 at 3:26 PM, Maurus Cuelenaere
> <mcuelenaere_at_gmail.com> wrote:
>> The way I see it how this should be done is something like:
>>
>>> /*
>>> Description of function. [REQUIRED]
>>> arg1: description of arg1 [OPTIONAL]
>>>
>>> arg2: description of arg2 [OPTIONAL]
>>> returns: description of return value [OPTIONAL]
>>> */
>>> int (*function)(int arg1, int arg2);
>
> That's pretty much like doxygen comments work, which would look like
> this (given that the AUTOBRIEF option is turned on, otherwise you'd
> need an additional @brief in the first line):
>

Which begs the question why not just use doxygen to generate the documentation?

-- 
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