How to use LuaDoc

Glider (IDE)
#1

Hi,

I would like to have my code “auto-documented” based on the comments taking advantage of LuaDoc http://keplerproject.github.io/luadoc/manual.html

If I am correct, lua Glider has LuaDoc “bundled” with it. I tried to add LuaDoc comments in my code. I looks like glider “understands” that code, but I could not see my documentation in any way.

This is the commented section

---@extends TextInput --@param params table with the properties of the TextInput --@param aux in case user called TextField:new function TextField.new(params, aux)     if params==TextField then    --resolve mistake of calling :new instated of .new         params=aux     end

In the autocomplete I cannot see any info of my function

In Source->Show Documentation does not show anything either.

Is it possible to further integrate with LuaDoc in order to export my documentation to HTML?

#2

Hello Igenapps,

There is a way but admittedly it is a bit clunky to use unless you have a second monitor. Please see the screenshot below:

http://view.xscreenshot.com/e5be40805f6474ab9cc5816fe02a7af4

You can access that page via help->documentation view

That screen also updates when you select autocomplete entries as well. We will get the menu item actions hooked up to it.

Regards,

M.Y. Developers

#3

This is more or less what I wanted indeed.

Is it possible to navigate through the documentation without having the cursor in a precise line?

Can I export it to html?

Is this the full list of tags available or glider recognises some more such as @extends?

Thanks!

#4

Hello Igenapps,

There is a way but admittedly it is a bit clunky to use unless you have a second monitor. Please see the screenshot below:

http://view.xscreenshot.com/e5be40805f6474ab9cc5816fe02a7af4

You can access that page via help->documentation view

That screen also updates when you select autocomplete entries as well. We will get the menu item actions hooked up to it.

Regards,

M.Y. Developers

#5

This is more or less what I wanted indeed.

Is it possible to navigate through the documentation without having the cursor in a precise line?

Can I export it to html?

Is this the full list of tags available or glider recognises some more such as @extends?

Thanks!