Rockbox mail archiveSubject: Re: tomas: docs PLUGIN_API,1.1,1.2
Re: tomas: docs PLUGIN_API,1.1,1.2
From: Tomas <tomas_at_salfischberger.nl>
Date: Thu, 02 Jun 2005 23:28:38 +0200
Daniel Stenberg wrote:
> What about showing the crowd an example? Modify a source accordingly,
> run doxygen and put the result on a URL for us to browse!
*added to todo list*
I'll try to make an example of the obvious funtions in plugin.h
> My personal experience with docs generated by doxygen is that the docs
> usually is very messy and unhelpful. I wish you prove me wrong.
It depends on what you've read... whole project documentation w/o
developers doing anything is messy... documenting just an API like in
plugin.h might be useable if the comments are done right.
Received on 2005-06-02