Skip to content

Commit

Permalink
vis-lua: add preliminary version of LDoc based Lua API documentation
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
martanne committed Dec 5, 2016
1 parent 6e2bfdc commit 960cd1c
Show file tree
Hide file tree
Showing 2 changed files with 368 additions and 3 deletions.
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading

0 comments on commit 960cd1c

Please sign in to comment.