finalise interface & documentation

Signed-off-by: Folling <mail@folling.io>

.clang-tidy

@@ -0,0 +1,26 @@
+Checks: >-
+  -*,
+  bugprone-*,
+  cppcoreguidelines-*, -cppcoreguidelines-owning-memory,
+  clang-analyzer-*,
+  google-*, -google-readability-todo,
+  modernize-*, -modernize-use-trailing-return-type,
+  performance-*, -performance-enum-size,
+  portability-*,
+  readability-*, -readability-redundant-access-specifiers
+CheckOptions:
+  readability-identifier-length.IgnoredParameterNames: '^(db|rc|id)$'
+  readability-identifier-length.IgnoredLoopCounterNames: '^[ij]$'
+  readability-identifier-length.IgnoredVariableNames: '^(db|rc|id)$'
+  cppcoreguidelines-avoid-do-while.IgnoreMacros: Yes
+HeaderFileExtensions:
+  - h
+  - hpp
+  - tpp
+  - ipp
+ImplementationFileExtensions:
+  - c
+  - cpp
+FormatStyle: file
+InheritParentConfig: false
+WarningsAsErrors: '*'