improve documentation of all user-facing functions

Sebastian Henzrequested to merge
feature/documentation into master

Closes #2 (closed).

Edited by Sebastian Henz

Merge request reports