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: Björn Stenberg <bjorn_at_haxx.se>
Date: Thu, 15 Jan 2009 16:17:53 +0100

Maurus Cuelenaere wrote:
> But the point of all this is that you don't really need to look stuff up in
> plugin.h anymore, but rather use the documentation output for that.

Does anyone really want to do that? Seriously?

I'm all for making the code easy to understand, but I'm not so sure flooding plugin.h with verbose text for every single function is the best way to accomplish that.

In fact, most of the functions in plugin.h don't even need any documentation. And those who do need brief, to-the-point explanations of the non-obvious aspects. Not "@param x X coordinate".

-- 
Björn
Received on 2009-01-15

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