review code documentation

[rizsotto]

This ticket is about the rust code.

The code was mainly written by me, and the doc make sense to me. I am developing this project more than 12 years, and some of the knowledge is only in my head. Therefore some documentation makes sense to me, but not to others.

I am looking for a third eye, who can cross check the written documentation in the code.

• Fix grammar, English language issues or fix style would be good contribution
• Add missing documentation for uncovered modules, functions
• Find out how to capture bigger architectural documentation would be great improvement
• Find out how to capture user documentation and make that available, could be also in scope of this work