boolangery/py-lua-doc

A Lua documentation tool.

py-lua-doc's Issues

Support function documentation on table assignment

It would be really nice to be able to write documentation for functions that are assigned to tables.

Class function example:

--- @function Car:get_speed
--- A function to measure the speed of the car
--- @return number Speed of the car in kph
Car.get_speed = utils.measure_speed

Workaround:

--- A function to measure the speed of the car
--- @return number Speed of the car in kph
function Car:get_speed() end
Car.get_speed = utils.measure_speed

Static function example:

--- @function Car.static_helper
--- A static helper function related to Car
Car.static_helper = utils.static_helper

Workaround:

--- A static helper function related to Car
function Car.static_helper() end
Car.static_helper = utils.static_helper

License mismatch between file and setup.py

setup.py indicates "MIT" license, but LICENSE file contains the text of the GNU General Public License.

Add a license

It can be kinda tricky to use/fork this without a license attached. It'd be appreciated if you could add one so I know I'm in the clear if I tweak this to format docs a little differently. :)

`[public|protected|private]` not optional in `@field`

Reading https://emmylua.github.io/annotations/field.html, [public|protected|private] should be optional in ---@field [public|protected|private] field_name FIELD_TYPE[|OTHER_TYPE] [@comment] because it's enclosed in [].

However I'm getting the error invalid @field tag: @field body string The contents of the request for:

---@class Request
---@field body string The contents of the request

and the error goes away if I insert a public right after @field.

Support `short_desc` and `desc` on explicit @function tags

Explicit function tags currently parse without a short_desc or desc.

For example:

--- @module our_module
local e = {}

--- Report a script error
--- <more info>
--- @function report_error
local report_error = function (...)
end

e = {
  report_error = report_error,
}

return e

turns into:

[
    {
        // ...
        "functions": [
            {
                "name": "report_error",
                "short_desc": "",
                "desc": "",
                "params": [],
                "returns": [],
                "usage": "",
                "is_virtual": false,
                "is_abstract": false,
                "is_deprecated": false,
                "is_static": false,
                "visibility": "public"
            },
        ],
        // ...
    }
]