[brailleblaster] Re: liblouisutdml.h
- From: "John J. Boyer" <john.boyer@xxxxxxxxxxxxxxxxx>
- To: brailleblaster@xxxxxxxxxxxxx
- Date: Thu, 1 Jul 2010 18:35:50 -0500
Laura,
Only liblouisutdml.h is an external interface. the other headers are for
internal use only. There is only one enum. Its purpoose seemed clear to
me. I don't want to put too many comments in a header file that other
programs will be using, since that would make it bulky. The comments do
point to the documentation.
I'll change the type of the mode arguments to ProcessingMode. That
should be clear.
louisutdml.h includes liblouisutdml.h but not the other way around.
In short, the bindings are for liblouisutdml.h alone. They should not
include anything from any other header. Similarly, the liblouis bindings
are for liblouis.h alone and should not include anything from any other
header.
John B.
On Thu, Jul 01, 2010 at 05:03:39PM -0500, qubit wrote:
> Hi John -- I downloaded your source -- some questions and comments.
>
> First, I couldn't help but notice that liblouisutdml.h and louisutdml.h
> include each other. Is this intentional? They both have guard macros so
> there's no problem, but it looks curious.
>
> Second, like in liblouis.h, you have several enums whose types you never use
> anywhere -- you define mode arguments to functions as unsigned int, and I
> didn't see in the comments which enum the mode arguments were referring to.
> It would be clearer if the use of the enum types were documented more
> clearly, and in the vicinity of the function prototypes, so as to avoid
> using the wrong enum. What you do is document raw values instead of
> enumerator names. This I think is dangerous. It would also be more awkward
> for the user (such as Yuemei).
>
> Finally, is there a need to put all the functions from liblouisutdml.h and
> louisutdml.h and the sem_*.h and whatever else in the interface?
>
> What definitions would be of most use to Yuemei?
> Anybody please comment on this last point.
>
> Oh and I also fixed a typo in a comment -- wow, I know...*smile*
>
> TIA for comments.
> --le
>
--
John J. Boyer; President, Chief Software Developer
Abilitiessoft, Inc.
http://www.abilitiessoft.com
Madison, Wisconsin USA
Developing software for people with disabilities
Other related posts:
