Missing class documentation

[jllv]

Migrating from sumnekos LuaLS, I noticed a change in the way class documentation strings are handled.

For my meta libraries, I used to write code in a similar pattern like this:

--- This is the MyModule documentation.
--- It should appear when hovering over MyModule.
--- @class MyModule
MyModule = {}


--- This is the SubModule documentation.
--- It should appear when hovering over SubModule.
--- @class MyModule.SubModule
MyModule.SubModule = {}

--- Creates a new SubModule instance
--- @return MyModule.SubModule
function MyModule.SubModule.create()
end

return MyModule

Using the Emmy LS, I now noticed that my documentation strings are not shown to the user when hovering over class usages.

To better showcase my issue, here is how the Emmy LS displays the hover message vs Sumnekos LuaLS:

Is there a way for me to adapt the format of my meta libraries to achieve a similar outcome to what I am used to?

[CppCXY]

the comment will attach to class self, for module I suggest donot declare class

[jllv]

Thanks for the quick reply!

I removed the ---@class annotation from MyModule, which did indeed improve the Hover message when using the MyModule class.

However, unless I misunderstood you, the problem with using SubModule persists.

Since I want to keep the meta lib in the background, it would be nice to provide the descriptions also when using the SubModule.