Feature/improve api docs
Summary
This MR provides an enhancement of the existing function documentation (including some slight refactoring and indenting) of the Ahiqar backend as far as I understood it. Please correct or point out every misunderstanding on my side.
Changes have moved from repo.xml to a CHANGELOG to 1. improve the visibility of changes and 2. to make keeping track of changes easier (in this case Markdown > HTML).
repo.xml now lists Michelle Weidling as additional author.
Use Cases
With a proper function documentation we can easily provide HTML rendered docs of our API. It also might help anyone interested to understand the API better.
Changelog
-
I added a statement to the CHANGELOG.
Related Tickets
subugoe/emo/Qviewer#8
Edited by Michelle Weidling