No support for classes that do not have a encompassing module

[FatalistError]

I have a file which contains my class, and there is no good way to make the class independent of a module. The name of the class is Gun and it shows up as Gun.Gun and worse yet, this breaks the links. I have to set it to class gun and when I do that the fields don't show up properly. It's utterly broken, there's no "classmod" like in ldoc that'll fix this. It's really frustrating,

[jtackaberry]

I don't understand the issue here, so would need more information, ideally a complete example to reproduce it.

This simple example does what I think you'd expect?

--- @class Gun
Gun = class('Gun')

--- Loads the gun.
--
-- @tparam number caliber the caliber of the bullet
-- @treturn bool true if the gun successfully loaded, false otherwise
function Gun:load(caliber)
    -- ...
end

--- Fires the gun.
--
-- @treturn bool true if the gun fired successfully, false if it jammed
function Gun:fire()
  -- ...
end

Which renders a page that looks like this:

[jtackaberry]

Ah, I was testing with the master branch which doesn't exhibit the reported behavior due to changes since the last release.

To workaround this, you can use the @display tag, so the above example becomes:

--- @class Gun
-- @display Gun
Gun = class('Gun')

--- Loads the gun.
--
-- @tparam number caliber the caliber of the bullet
-- @treturn bool true if the gun successfully loaded, false otherwise
function Gun:load(caliber)
    -- ...
end

--- Fires the gun.
--
-- @treturn bool true if the gun fired successfully, false if it jammed
function Gun:fire()
  -- ...
end

You can still reference Gun in other files. For example, suppose we have a range.lua:

--- @class Range
--- @display Range
Range = class('Range')

--- Registers a gun with the range.
--
-- @tparam Gun gun an instance of a gun to register
function Range:register(gun)
    -- ...
end

With LuaDox 1.3, these pages render as:

[FatalistError]

ok well perhaps I'm using it incorrectly. I'm trying to make a class that has numerous levels of sub-tables and for some reason i recall the only way i could get it to work was doing some weird naming thing (thats what the lvl1_fields thing is

[FatalistError]

locally it gives me this which is what i'd expect. But when upload it to github pages the index on the sidebar leads me to a 404 when i click on Gun.Gun. The class "index/gun.html" doesnt exist but "index/Gun.html" does. Why it works locally but not there is beyond me, but it seems to be inherently related to the class tag.

[FatalistError]

oh ok thanks that helps, dunno if that fixes the issue with the link though...

[jtackaberry]

dunno if that fixes the issue with the link though...

Give it a try and let me know. It seems ok here, at least in the example. They render as class/Gun.html and class/Range.html and the links on the sidebar work as well as the Gun reference link from the Range docs.

[FatalistError]

dunno if that fixes the issue with the link though...

Give it a try and let me know. It seems ok here, at least in the example. They render as class/Gun.html and class/Range.html and the links on the sidebar work as well as the Gun reference link from the Range docs.

nope, it's still linking

which is not a page.

[FatalistError]

my docs indeed suck btw, but @Class appears to entirely break links. This error also turns up strangely

[FatalistError]

(btw if you look at the site yes I am well aware my documentation currently is terrible)

[jtackaberry]

Can you share how you're invoking luadox?

I will take a closer look this weekend and see what adjustments we can make to render things properly.

[FatalistError]

the filename is called Gun.lua and when I set the class to that name, it does this:

it renders it as a module instead.

[FatalistError]

Can you share how you're invoking luadox?

I will take a closer look this weekend and see what adjustments we can make to render things properly.

just a really simple batch file so i dont have to call it from powershell every time.

[FatalistError]

i just copied the default config and added my own paths. It's for some reason behind two folders (don't even ask I don't know). That shouldn't be the issue here though