search

JakobOvrum / LuaD

Bridge to Lua from the D programming language
http://jakobovrum.github.io/LuaD/
Other
176 stars 40 forks source link

automatic documentation generation #22

Open Trass3r opened 13 years ago

Trass3r commented 13 years ago

Beware: this is just a premature thought. Every app that exposes some of its functions and classes to Lua probably wants to generate some API documentation to pass it over to the scripting team. Especially when the API is changed quite often during the development of the main app it is desirable to automate this procedure.

I'm not sure if LuaD can do anything to ease that. Of course you could output some text in the registerClass etc. functions that at least describe what functions are available but you probably can't get ahold of their ddoc comments.

JakobOvrum commented 13 years ago

Don't you think it's simpler to just document those functions and classes as D documentation, then have the scripting team use the stack.d conversion rules to learn how to use it? The generated wrappers enforce a sense of type safety encoded in the D declarations, all that needs to be carefully explained if you were to generate Lua documentation ala LuaDoc.

Trass3r commented 13 years ago

Yep, one could also tag the exported functions somehow in the ddoc comments so you can filter the results. Still one would have to manually include what the actual function name in Lua is.

JakobOvrum commented 13 years ago

Yeah, but you would always have to do that.