diff options
author | Robin Haberkorn <robin.haberkorn@googlemail.com> | 2023-09-13 17:26:53 +0300 |
---|---|---|
committer | Robin Haberkorn <robin.haberkorn@googlemail.com> | 2023-09-13 17:26:53 +0300 |
commit | 7fc0f17fb37326c86a83627b856a5b75f522c090 (patch) | |
tree | bc5de8b30c705afafc9b30e6fd3f5bc2b12f19d6 /applause.c | |
parent | 1cfaa431c1f3c4f417811dcff342c9f28600f13f (diff) | |
download | applause2-7fc0f17fb37326c86a83627b856a5b75f522c090.tar.gz |
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.
Diffstat (limited to 'applause.c')
0 files changed, 0 insertions, 0 deletions