Re: [lcd4linux] Re: [Lcd4linux-devel] function naming changed in CVS

[Michael R. <re...@eu...>]

Hi List,

>>Can anyone tell me how to write documentation? I didn't follow these 
>>discussions...
> 
Jerry answered:
> Off the top of my head, I can't.  I have just been writing plain text
> for the moment, I write better that way.  I'll be working on
> formatting/markup hopefully next week.

Hmm. What came to my mind is something like "embedded documentation", at 
least for all calls to cfg_get()/cfg_number(), and for all functions a 
plugin provides.

This would be 1) clear text, and 2) always up-to-date with the code

What do you think? Is there a "common format" for such things?


bye, Michael

-- 
Michael Reinelt                                   Tel: +43 676 3079941
Geisslergasse 4                                   Fax: +43 316  692343
A-8045 Graz, Austria                          e-mail: re...@eu...