diff options
| author | Marc André Tanner <mat@brain-dump.org> | 2016-12-05 23:12:26 +0100 |
|---|---|---|
| committer | Marc André Tanner <mat@brain-dump.org> | 2016-12-05 23:28:21 +0100 |
| commit | 960cd1c7c84c4573f99d4e389548183ebbdc4f35 (patch) | |
| tree | 459641f52d7e0f142ef10c79ab2c1dd7793f5065 /Makefile | |
| parent | 6e2bfdc1ac0c9b2942f6cfac418e8a527752ae11 (diff) | |
| download | vis-960cd1c7c84c4573f99d4e389548183ebbdc4f35.tar.gz vis-960cd1c7c84c4573f99d4e389548183ebbdc4f35.tar.xz | |
vis-lua: add preliminary version of LDoc based Lua API documentation
A new Makefile target `luadoc` has been added which generates
HTML documentation in the doc subfolder using ldoc(1) from
https://stevedonovan.github.io/ldoc/
There are still a few problems to resovle, for example the links (e.g.
in parameter lists) to our custom types seem to be broken.
At this point only the C part of the Lua API is covered and even
that is not yet complete.
Diffstat (limited to 'Makefile')
| -rw-r--r-- | Makefile | 4 |
1 files changed, 4 insertions, 0 deletions
@@ -85,6 +85,10 @@ man: sed -e "s/VERSION/${VERSION}/" "$$m" | mandoc -W warning -T utf8 -T xhtml -O man=%N.%S.html -O style=mandoc.css 1> "$$m".html || true; \ done +luadoc: + @ldoc -p "Vis Editor" -f markdown -M vis-lua.c -s '!pale' && \ + sed -e "s/RELEASE/${VERSION}/" -i doc/index.html + install: vis vis-menu @echo stripping executable @${STRIP} vis |