Everyone knows that a good documentation is key for understanding and using any library. Achieving this however is a major undertaking. All in all, this library consists of about 70 files with more than 400 thousand characters, even with not counting the usual 35 lines copyright header . The main test driver program has more than 150 thousand characters on its own on top of the 400k.
In order to avoid the usual gap between documentation and source code, I’ve put quite some amount of explanations into the source code. More than 30% of the source code lines are commented, and the documentation here is extracted from the source code.
Without setting myself some guidelines and design principles, a project of this size would not have come to an end.
The follwing documents are available for your pleasure and reference:
- Algorithms & Background information