[liblouis-liblouisxml] Re: What do you want documented?
- From: Christian Egli <christian.egli@xxxxxxxx>
- To: liblouis-liblouisxml@xxxxxxxxxxxxx
- Date: Wed, 11 Mar 2009 16:43:30 +0100
Hi
On Mon, 2009-02-23 at 04:22 -0600, John J. Boyer wrote:
> I think it would be nice to get the documentation for liblouis and
> liblouisxml in the best shape possible before the upcoming releases. Is
> there anyone besides Christian who has experience with texinfo
> documentation? What would you like to see documented? How would you like
> to see the documentation imploved? I would like to document the new
> liblouis ability to find tables automatically and the new
> lou_getProgramPath function.
I guess the stuff with the env variable should be documented. However
what I would like to see is documentation on all the semantic actions.
As far as I am concerned if it is not documented it does not exist.
If I compare the documentation in liblouisxml.texi and the actual code
in sem_names.h I get the following discrepancies:
* allcaps seems to be only in the documentation
* contents is in the documentation, contents1, contents2, etc is
in the code
* changetable is not documented
* compbrl is not documented
* generic is not documented
* linkto is mentioned in the docu but not in the code
* htmllink and htmltarget are not documented
* mtable is not documented
* noindent is in the docu but not in the code
* pagenum is not documented
* reverse is not documented
* rightalign is mentioned in the docs but not in the code
* specsym is mentioned in the docs but not in the code
Thanks
Christian
--
Christian Egli
Swiss Library for the Blind and Visually Impaired
Grubenstrasse 12, CH-8045 Zürich, Switzerland
For a description of the software and to download it go to
http://www.jjb-software.com
Other related posts:
