boolangery / py-lua-doc Goto Github PK
View Code? Open in Web Editor NEWA Lua documentation tool.
License: GNU General Public License v3.0
A Lua documentation tool.
License: GNU General Public License v3.0
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
setup.py
indicates "MIT" license, but LICENSE
file contains the text of the GNU General Public 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. :)
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
.
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"
},
],
// ...
}
]
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.