mes-luadoc v1.0.6

MES-LuaDoc

This package created for generate documentation for Lua language. This package is meant to be one movement to simplify your life.

Create js file with similar code

const MesLuaDoc = require('mes-luadoc');

MesLuaDoc.MesLuaDoc('.')

And for example we have .lua file with documentation

local Diary = {};
Diary.metatable = {};
Diary.metatable.__index = Diary;

--[=====[
	@type func
	@name Diary:init
	@brief Init diary variables
--]=====]
function Diary:init()
end

--[=====[
    @type func
	@name Diary:toggle
	@param state:bool Diary will be close or open
	@brief Toggle diary visibility
--]=====]
function Diary:toggle(state)
end

Attention! You need have multiline comments --[=====[ Your docs --]=====]

And now run doc generator!

Programm create docs folder with documentation