API

The API documentation is far from complete. It is automatically generated using doxygen, which in turn relies on information written in the header files. This is geing addressed on a piecemeal basis. When files are edited, efforts are made to throw a little more doxygen recognised comments in.

When the development pace eases up a little, usually between releases, the oppertunity to add more comments to the code increases, improving the API documentation. This is an on-going effort, so updates will only be made when a certain amount of API doc changes have been made. Sporadic, untimely updates might be more accurate.

Anyone wanting to add more to the API docs, by editing any of the header files will not be in the slightest way discouraged. The svn repository for bhpos 2 is private at the moment, but you can request access by e-mail.

Click here for the BhPOS 2.0 API