[BRLTTY] Documentation of BrlAPI

[Dave Mielke]

[quoted lines by Sebastian Humenda on 2014/03/01 at 14:09 +0100]

>In the BRLTTY release there are man pages for the BrlAPI reference. According to
>the Debian error spotting utility Lintian, there are some mistakes in the
>formatting of the man pages (e.g. incorrect what-is section, etc.). I could
>easily fix those, but it looks to me if the files were auto-generated. Then it
>would make more sense to fix it in the conversion itself. Can anybody point me
>there to the appropriate program / where I could start?

The docukentation is within special comments (those which begin with /**) in 
the BrlAPi header files (brlapi.h.in and brlapi_*.h). The documentation is 
created by doing "make BrlAPIref" within the Documents/ subdirectory.

>BTW, in Programs/brlapi_server.c Lintian found a mistake: ressource instead of
>resource. Could you please fix that?

Done.

-- 
Dave Mielke           | 2213 Fox Crescent | The Bible is the very Word of God.
Phone: 1-613-726-0014 | Ottawa, Ontario   | http://Mielke.cc/bible/
EMail: dave at mielke.cc | Canada  K2A 1H7   | http://FamilyRadio.com/