From 960cd1c7c84c4573f99d4e389548183ebbdc4f35 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc=20Andr=C3=A9=20Tanner?= Date: Mon, 5 Dec 2016 23:12:26 +0100 Subject: 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. --- Makefile | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'Makefile') diff --git a/Makefile b/Makefile index 3c9f746..c2b4d04 100644 --- a/Makefile +++ b/Makefile @@ -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 -- cgit v1.2.3