|
From: | Gao Bin |
Subject: | Re: [Freeon-users] freeon documentation |
Date: | Fri, 20 Apr 2012 23:28:10 +0000 |
Hi, Nicolas and Jose
Thank you for your reply. I will try to use FreeON and write to the mailing list if there is any question. I am also fond of the wiki page, since everyone could contribute to the usage of FreeON. Cheers Gao From: Nicolas Bock address@hidden
Sent: Friday, April 20, 2012 8:12 PM To: Jose R. Valverde Cc: address@hidden; Gao Bin Subject: Re: [Freeon-users] freeon documentation We have tossed around the idea of a wiki, but have settled for now to using doxygen because it allows for a self contained and simple way to document the API and the code itself. That does not mean of course that we shouldn't also create a wiki. And I
really appreciate Jose's suggestion to volunteer for the wiki, I am afraid that Matt and I are a little overloaded at the moment and couldn't run the wiki ourselves.
Doxygen is sort what javadoc is to java but for other languages. It extracts comments from the source code files and assembles a webpage and/or a pdf file. I will push out the necessary changes to savannah very soon, so you all can see how this works.
Please feel free to send us patches to the sources that add documentation. I will keep the repository on savannah updated so that you can all track how the documentation progresses. And if we got a wiki going, I think that would be awesome, and we could
run it side by side with the doxygen documentation.
Thanks again Jose for volunteering here.
nick
On Fri, Apr 20, 2012 at 11:57, Jose R. Valverde
<address@hidden> wrote:
I think Nicolas' answer summarizes it very well. It would be nice if |
[Prev in Thread] | Current Thread | [Next in Thread] |