[BRLTTY] Documentation of BrlAPI

[Sebastian Humenda]

Hello Dave,

Dave Mielke schrieb am 01.03.2014, 12:27 -0500:
>[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.
Thanks, so it's doxygen which translates not quite correctly to the groff output
(or at least to the conventions): the "whatis" section looks like:
<function \-
but should be
<function> \- short description

>>BTW, in Programs/brlapi_server.c Lintian found a mistake: ressource instead of
>>resource. Could you please fix that?
>
>Done.
Could you please fix another one?
Drivers/Braille/VisioBraille/vstp.1
"overiden" instead of "overidden".

Thanks!
Sebastian
-- 
Web: http://www.crustulus.de | Blog: http://www.crustulus.de/cgi-bin/blog.cgi?de-0
Freies Latein-Deutsch-Wörterbuch: http://www.crustulus.de/freedict.de.html
FreeDict: Free multilingual dictionary databases - http://www.freedict.org
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 181 bytes
Desc: Digital signature
URL: <http://mielke.cc/pipermail/brltty/attachments/20140301/61378d67/attachment.sig>