lua-users home
lua-l archive

[Date Prev][Date Next][Thread Prev][Thread Next] [Date Index] [Thread Index]


On Tue, Dec 17, 2013 at 8:03 AM, Andrew Starks <andrew.starks@trms.com> wrote:
> ---This is my class constructor
> --@function MyClass --This is not obvious from the documentation.
> There wasn't anywhere that I saw, which pointed out that you can ommit
> __init from the documentation by doing this. I might be blind,
> however. :)

Eh, sorry for the noise. I'm wrong.


Given
```
---@type MyClass

---The constructor, which takes arguments that I'll explain with
LDoc's param feature
--@param args -- see previous comment
function MyClass:__init(args)

...

```

How do I make the type (class) constructor documentation without the
`__init` field making it into the documentation, given that the user
actually calls it like so: `MyClass(args)`?

-Andrew