search

vancegroup / vr-jugglua

VR JuggLua: A Framework for VR Applications Combining Lua, OpenSceneGraph, and VR Juggler
Boost Software License 1.0
11 stars 12 forks source link

Generate vrjlua reference documentation by introspection #48

Open rpavlik opened 12 years ago

rpavlik commented 12 years ago

We should be able to rig together a way to output documentation by interacting with Luabind's representation of the interface. Ideally, we'd also be able to stash some help text in Luabind's data (perhaps as a policy) and access that both through lua-docstring and when generating this reference doc. I would imagine that such reference docs would be in HTML, though Markdown is also an option (and probably easier) since we already have markdown-to-html conversion working well.

rpavlik commented 12 years ago

http://stevedonovan.github.com/ldoc/topics/doc.md.html

In progress

rpavlik commented 12 years ago

Issues filed with LDoc: https://github.com/stevedonovan/LDoc/issues/9 - multiple human-written docs

https://github.com/stevedonovan/LDoc/issues/10 - request for hierarchical display of examples.

rpavlik commented 12 years ago

https://github.com/stevedonovan/LDoc/issues/11 request to skip the parsing step.