2

I am in the beginning phase of create a mobile MMO with my team. The server software will be written in JavaScript using NodeJS, and the client software in Lua using Corona. We need a tool to auto-generate documentation for both the server-side and client-side code.

Are there any tools which can generate documentation for both Lua and Javascript? And as a bonus: we are hosting our project on Bitbucket and the Bitbucket Wiki uses the Creole markup language. So if it's possible I want the tool to export to Creole.

Edit: I know about tools for generating documentation for one of both languages. However, I don't want 2 different styles for documentation in one project. Therefore one tool which can generate documentation for both languages would be great.

Improve this question
4
  • 1
    I don't know any tool for both of them. But for Lua there is LuaDoc. And a little googling led me to this question at StackOverflow.
    – Machado
    Oct 9, 2012 at 12:32
  • Thanks for your comment, but I am really looking for a tool which can do both. I'd like to have a uniform documentation style, and if I use 2 different tools then I will have 2 different styles of documentation.
    – Tiddo
    Oct 9, 2012 at 17:26
  • I understand, but if you don't mind, I'd like to share a thought: From your point of view, this make sense: 1 style fits all documentation. From my point of view, if I'm working with Lua, I expect the documentation in Luadoc-style. If I'm working with Java, I expect the documentation on JavaDoc-style. If I'm working with .Net, in MSDN-style, and so on. My (uninformed) opinion is that an "one-style-fits-all" documentation does not make your API easier to use to a new developer.
    – Machado
    Oct 9, 2012 at 21:43
  • I agree with you. We end up using LuaDoc and JSDoc. They are quite similar and this was the closest we could get to an ideal solution without writing our own document generator.
    – Tiddo
    Oct 10, 2012 at 10:06

1 Answer 1

Reset to default
1

Sphinx currently only does Javascript but it includes a modular system to add new languages. Maybe not the simpler solution but with some work it would be usable with the two languages.

As a reference, Erlang extension file is written in ~400 LOC.

python-creole allow conversion between Creole and reStructuredText (via HTML).

Improve this answer

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge that you have read and understand our privacy policy and code of conduct.

Not the answer you're looking for? Browse other questions tagged or ask your own question.