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: tomas: docs PLUGIN_API,1.1,1.2

Re: tomas: docs PLUGIN_API,1.1,1.2

From: Daniel Stenberg <daniel_at_rockbox.org>
Date: 2005-06-02

On Thu, 2 Jun 2005, Tomas wrote:

>> What does it mean to be doxygen compatible? What is required?

> There have to be comments explaining the functions in a doxygen compatible
> format (there are lots of them). Then doxygen can read the file and make a
> nice formatted page about it, containing the names, parameters and those
> descriptions.

What about showing the crowd an example? Modify a source accordingly, run
doxygen and put the result on a URL for us to browse!

My personal experience with docs generated by doxygen is that the docs usually
is very messy and unhelpful. I wish you prove me wrong.

-- 
  Daniel Stenberg -- http://www.rockbox.org/ -- http://daniel.haxx.se/
_______________________________________________
http://cool.haxx.se/mailman/listinfo/rockbox
Received on Thu Jun 2 23:08:10 2005

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