Rockbox mail archiveSubject: Re: API documentation
Re: API documentation
From: Amaury Pouly <amaury.pouly_at_gmail.com>
Date: Sat, 11 Dec 2010 15:09:17 +0100
> This is independent from the tool used later to parse this.
I partly agree and disagree :)
it is independent from the tool is the sense that you can easily parse the
short description and the detailled description with any tool.
What is not independent from the tool is how you describe the parameters for
example. Usually, you want to either
* list them and put a description
* or write some texte and put some references to the arguments
As far as I know (and I don't know much about such tools :)), there are
different conventions right ?
Received on 2010-12-11