Generate Lua documentation

Solar2D General Questions/Discussion
#1

Hello guys!

I have trouble when work with Lua - it is that I can’t generate Lua documentation. I found some article obout how create but I found then too intricate. So I decided create own module for generate documentation.

I use Node.js so you need will be only do netx step:

  • Install Node.js
  • Run next command in your project directory
  • npm init
  • npm i luadoc
  • create file luadoc.js with next content

const MesLuaDoc = require(‘luadoc’);

 

MesLuaDoc.MesLuaDoc(’.’)

  • and run 
  • node luadoc.js

More details about this module you can find on this linke https://www.npmjs.com/package/luadoc

I really want create something useful for Corona SDK and make life easier for all of us!

#2

Or you could just use sublime, install the corona sdk package and then simply press F1 to get context sensitive help on each keyword… it is a lot simpler

#3

Or you could just use sublime, install the corona sdk package and then simply press F1 to get context sensitive help on each keyword… it is a lot simpler