added LDoc documentation

* gives a useful overview of everything supported right now
* especially the type documentation is useful, as these things are not self-evident in Lua (because of dynamic typing).
* The LDoc page can later be published as the Github pages of the project.
  This can even be done automatically by a Github action.
  However, we should first make sure that it's okay to publish the project before defending the thesis since
  Github pages will always be public even for private repositories.
* Documentation of command-line parameters is lacking (TODO).
* It may be possible to use types like "Stream(number)" to describe streams of numbers.
  The LDoc documentation mentions boxed types.
  Perhaps there can even be Streamable(number)?
* We are also lacking good example programs and/or introductory material.

1 files changed, 4 insertions, 0 deletions

diff --git a/sndfile.lua b/sndfile.lua
index 8f2a5e7..1e6f6b7 100644
--- a/sndfile.lua
+++ b/sndfile.lua
@@ -1,3 +1,7 @@
+---
+--- @classmod sndfile
+---
+
 -- module table
 local sndfile = {}