Rockbox mail archiveSubject: RE: API documentation
RE: API documentation
From: Mike Giacomelli <giac2000_at_hotmail.com>
Date: Sat, 11 Dec 2010 12:32:19 -0700
> Before we can start adding documentation we need to know which format to use :)
> I'm in strong preference for Doxygen since it's IMO a quite natural
> format that doesn't get in the way too much, especially if the Javadoc
> Autobrief style is enabled. Also, since Doxygen is quite popular I
> think it's a good choice. I'm willing to look into customizing the
> Doxygen output if there is enough interest, I'll try to find some time
> for that during the holidays.
I agree with this post. Doxygen is fine with me unless someone really wants to roll their own.
I'm willing to document the (tiny) bits and pieces of the code I actually understand.
Received on 2010-12-11