MRR/traintastic
1
0
Fork 0
Code Issues Pull-Requests Actions 1 Pakete Projekte Releases Wiki Aktivität

luadoc: added version/lua badges

Quellcode durchsuchen
Dieser Commit ist enthalten in:
Reinder Feenstra 2023-12-29 10:24:00 +01:00
Ursprung 68cffe287c
Commit efc89052a5
10 geänderte Dateien mit 246 neuen und 104 gelöschten Zeilen
Statistiken anzeigen Patch-Datei herunterladen Vergleichs-Datei herunterladen Alle Dateien ausklappen Alle Dateien einklappen

35
manual/buildluadoc.py
Datei anzeigen

@ -429,7 +429,12 @@ class LuaDoc:
html += '<dl>' + os.linesep
for item in constants:
item_term_prefix = item['term_prefix'] if 'term_prefix' in item else term_prefix
html += ' <dt id="' + item['lua_name'] + '"><code>' + lua_prefix + item['lua_name'] + '</code></dt>' + os.linesep
html += ' <dt id="' + item['lua_name'] + '"><code>' + lua_prefix + item['lua_name'] + '</code>'
if 'since' in item:
html += ' <span class="badge badge-since">&ge; ' + item['since'] + '</span>'
if 'is_lua_builtin' in item and item['is_lua_builtin']:
html += ' <span class="badge badge-lua">Lua</span>'
html += '</dt>' + os.linesep
html += ' <dd>' + self._get_term(item_term_prefix + item['lua_name'].lower() + ':description') + '</dd>' + os.linesep
html += '</dl>' + os.linesep
@ -438,7 +443,12 @@ class LuaDoc:
html += '<h2 id="libraries">' + self._get_term('libraries') + '</h2>' + os.linesep
html += '<dl>' + os.linesep
for item in libraries:
html += ' <dt id="' + item['lua_name'] + '"><code>' + lua_prefix + item['lua_name'] + '</code></dt>' + os.linesep
html += ' <dt id="' + item['lua_name'] + '"><code>' + lua_prefix + item['lua_name'] + '</code>'
if 'since' in item:
html += ' <span class="badge badge-since">&ge; ' + item['since'] + '</span>'
if 'is_lua_builtin' in item and item['is_lua_builtin']:
html += ' <span class="badge badge-lua">Lua</span>'
html += '</dt>' + os.linesep
if item['lua_name'] == 'enum':
href = LuaDoc.FILENAME_ENUM
elif item['lua_name'] == 'set':
@ -454,7 +464,10 @@ class LuaDoc:
html += '<dl>' + os.linesep
for item in objects:
item_term_prefix = item['term_prefix'] if 'term_prefix' in item else term_prefix
html += ' <dt id="' + item['lua_name'] + '"><code>' + lua_prefix + item['lua_name'] + '</code></dt>' + os.linesep
html += ' <dt id="' + item['lua_name'] + '"><code>' + lua_prefix + item['lua_name'] + '</code>'
if 'since' in item:
html += ' <span class="badge badge-since">&ge; ' + item['since'] + '</span>'
html += '</dt>' + os.linesep
html += ' <dd>' + self._get_term(item_term_prefix + item['lua_name'].lower() + ':description') + '</dd>' + os.linesep
html += '</dl>' + os.linesep
@ -464,7 +477,10 @@ class LuaDoc:
html += '<dl>' + os.linesep
for item in properties:
item_term_prefix = item['term_prefix'] if 'term_prefix' in item else term_prefix
html += ' <dt id="' + item['lua_name'] + '"><code>' + lua_prefix + item['lua_name'] + '</code></dt>' + os.linesep
html += ' <dt id="' + item['lua_name'] + '"><code>' + lua_prefix + item['lua_name'] + '</code>'
if 'since' in item:
html += ' <span class="badge badge-since">&ge; ' + item['since'] + '</span>'
html += '</dt>' + os.linesep
html += ' <dd>' + self._get_term(item_term_prefix + item['lua_name'].lower() + ':description') + '</dd>' + os.linesep
html += '</dl>' + os.linesep
@ -480,6 +496,10 @@ class LuaDoc:
html += '[]'
else:
html += item['lua_name']
if 'since' in item:
html += ' <span class="badge badge-since">&ge; ' + item['since'] + '</span>'
if 'is_lua_builtin' in item and item['is_lua_builtin']:
html += ' <span class="badge badge-lua">Lua</span>'
html += '</code></h3>' + os.linesep
html += '<code>' + lua_prefix
@ -529,7 +549,10 @@ class LuaDoc:
for item in events:
item_term_prefix = item['term_prefix'] if 'term_prefix' in item else term_prefix
html += '<h3 id="' + item['lua_name'] + '"><code>' + item['lua_name'] + '</code></h3>' + os.linesep
html += '<h3 id="' + item['lua_name'] + '"><code>' + item['lua_name'] + '</code>'
if 'since' in item:
html += ' <span class="badge badge-since">&ge; ' + item['since'] + '</span>'
html += '</h3>' + os.linesep
html += '<p>' + self._get_term(term_prefix + item['lua_name'].lower() + ':description') + '</p>' + os.linesep
html += 'Handler: <code>function ('
@ -731,6 +754,8 @@ class LuaDoc:
for tag, id, title in re.findall(r'<(h2|h3|dt) id="(.+?)">(.+?)</\1>', html):
title = re.sub(r'<a[^>]*>(.*?)</a>', r'\1', title) # remove links
title = re.sub(r'^(<code>)[a-z0-9_\.]+\.', r'\1', title) # remove Lua lib stuff
title = re.sub(r'<span class="badge.+?</span>', '', title) # remove badges
title = title.strip() # remove leading/tailing spaces
depth = 2 if tag == 'h2' else 3
if depth > current_depth:
toc += '<ul>'

6
manual/luadoc/class.json
Datei anzeigen

@ -11,7 +11,8 @@
{
"code": "class.get(world) -- returns: class.WORLD"
}
]
],
"since": "0.1"
},
"BOARD": {
"type": "constant"
@ -173,6 +174,7 @@
"type": "constant"
},
"WORLD": {
"type": "constant"
"type": "constant",
"since": "0.1"
}
}

63
manual/luadoc/globals.json
Datei anzeigen

@ -3,80 +3,103 @@
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"pairs": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"ipairs": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"next": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"tonumber": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"tostring": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"type": {
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"VERSION": {
"type": "constant"
"type": "constant",
"since": "0.1"
},
"VERSION_MAJOR": {
"type": "constant"
"type": "constant",
"since": "0.1"
},
"VERSION_MINOR": {
"type": "constant"
"type": "constant",
"since": "0.1"
},
"VERSION_PATCH": {
"type": "constant"
"type": "constant",
"since": "0.1"
},
"LUA_VERSION": {
"type": "constant"
"type": "constant",
"since": "0.1"
},
"world": {
"type": "object"
"type": "object",
"since": "0.1"
},
"log": {
"type": "library"
"type": "library",
"since": "0.1"
},
"class": {
"type": "library"
"type": "library",
"since": "0.1"
},
"enum": {
"type": "library"
"type": "library",
"since": "0.1"
},
"math": {
"type": "library"
"is_lua_builtin": true,
"type": "library",
"since": "0.1"
},
"set": {
"type": "library"
"type": "library",
"since": "0.1"
},
"string": {
"type": "library"
"is_lua_builtin": true,
"type": "library",
"since": "0.1"
},
"table": {
"type": "library"
"is_lua_builtin": true,
"type": "library",
"since": "0.1"
}
}

21
manual/luadoc/log.json
Datei anzeigen

@ -10,7 +10,8 @@
"optional": true
}
],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"info": {
"type": "function",
@ -23,7 +24,8 @@
"optional": true
}
],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"notice": {
"type": "function",
@ -36,7 +38,8 @@
"optional": true
}
],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"warning": {
"type": "function",
@ -49,7 +52,8 @@
"optional": true
}
],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"error": {
"type": "function",
@ -62,7 +66,8 @@
"optional": true
}
],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"critical": {
"type": "function",
@ -75,7 +80,8 @@
"optional": true
}
],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"fatal": {
"type": "function",
@ -88,6 +94,7 @@
"optional": true
}
],
"return_values": 0
"return_values": 0,
"since": "0.1"
}
}

81
manual/luadoc/math.json
Datei anzeigen

@ -7,7 +7,8 @@
"name": "number"
}
],
"return_values": 1
"return_values": 1,
"since": "0.1"
},
"acos": {
"is_lua_builtin": true,
@ -17,7 +18,8 @@
"name": "number"
}
],
"return_values": 1
"return_values": 1,
"since": "0.1"
},
"asin": {
"is_lua_builtin": true,
@ -27,7 +29,8 @@
"name": "number"
}
],
"return_values": 1
"return_values": 1,
"since": "0.1"
},
"atan": {
"is_lua_builtin": true,
@ -37,7 +40,8 @@
"name": "number"
}
],
"return_values": 1
"return_values": 1,
"since": "0.1"
},
"ceil": {
"is_lua_builtin": true,
@ -47,7 +51,8 @@
"name": "number"
}
],
"return_values": 1
"return_values": 1,
"since": "0.1"
},
"cos": {
"is_lua_builtin": true,
@ -57,7 +62,8 @@
"name": "number"
}
],
"return_values": 1
"return_values": 1,
"since": "0.1"
},
"deg": {
"is_lua_builtin": true,
@ -67,7 +73,8 @@
"name": "number"
}
],
"return_values": 1
"return_values": 1,
"since": "0.1"
},
"exp": {
"is_lua_builtin": true,
@ -77,7 +84,8 @@
"name": "number"
}
],
"return_values": 1
"return_values": 1,
"since": "0.1"
},
"floor": {
"is_lua_builtin": true,
@ -87,7 +95,8 @@
"name": "number"
}
],
"return_values": 1
"return_values": 1,
"since": "0.1"
},
"fmod": {
"is_lua_builtin": true,
@ -100,11 +109,13 @@
"name": "divisor"
}
],
"return_values": 1
"return_values": 1,
"since": "0.1"
},
"huge": {
"is_lua_builtin": true,
"type": "constant"
"type": "constant",
"since": "0.1"
},
"log": {
"is_lua_builtin": true,
@ -118,7 +129,8 @@
"optional": true
}
],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"max": {
"is_lua_builtin": true,
@ -131,11 +143,13 @@
"name": "..."
}
],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"maxinteger": {
"is_lua_builtin": true,
"type": "constant"
"type": "constant",
"since": "0.1"
},
"min": {
"is_lua_builtin": true,
@ -148,11 +162,13 @@
"name": "..."
}
],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"mininteger": {
"is_lua_builtin": true,
"type": "constant"
"type": "constant",
"since": "0.1"
},
"modf": {
"is_lua_builtin": true,
@ -162,17 +178,20 @@
"name": "number"
}
],
"return_values": 2
"return_values": 2,
"since": "0.1"
},
"pi": {
"is_lua_builtin": true,
"type": "constant"
"type": "constant",
"since": "0.1"
},
"rad": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"random": {
"is_lua_builtin": true,
@ -187,48 +206,56 @@
"optional": true
}
],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"randomseed": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"sin": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"sqrt": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"tan": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"tointeger": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"type": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"ult": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
}
}

3
manual/luadoc/object/blockrailtile.json
Datei anzeigen

@ -20,7 +20,8 @@
{
"name": "direction"
}
]
],
"since": "0.3"
},
"on_train_removed": {
"parameters": [

33
manual/luadoc/object/clock.json
Datei anzeigen

@ -1,10 +1,22 @@
{
"time": {},
"hour": {},
"minute": {},
"multiplier": {},
"freeze": {},
"running": {},
"time": {
"since": "0.2"
},
"hour": {
"since": "0.2"
},
"minute": {
"since": "0.2"
},
"multiplier": {
"since": "0.2"
},
"freeze": {
"since": "0.2"
},
"running": {
"since": "0.2"
},
"on_resume": {
"parameters": [
{
@ -13,20 +25,23 @@
{
"name": "multiplier"
}
]
],
"since": "0.2"
},
"on_tick": {
"parameters": [
{
"name": "time"
}
]
],
"since": "0.2"
},
"on_freeze": {
"parameters": [
{
"name": "time"
}
]
],
"since": "0.2"
}
}

42
manual/luadoc/object/world.json
Datei anzeigen

@ -1,21 +1,40 @@
{
"uuid": {},
"name": {},
"scale": {},
"scale_ratio": {},
"boards": {},
"clock": {},
"uuid": {
"since": "0.1"
},
"name": {
"since": "0.1"
},
"scale": {
"since": "0.1"
},
"scale_ratio": {
"since": "0.1"
},
"boards": {
"since": "0.1"
},
"clock": {
"since": "0.2"
},
"trains": {},
"rail_vehicles": {},
"state": {},
"power_off": {},
"stop": {},
"state": {
"since": "0.1"
},
"power_off": {
"since": "0.1"
},
"stop": {
"since": "0.1"
},
"get_object": {
"parameters": [
{
"name": "id"
}
]
],
"since": "0.1"
},
"on_event": {
"parameters": [
@ -25,6 +44,7 @@
{
"name": "event"
}
]
],
"since": "0.1"
}
}

48
manual/luadoc/string.json
Datei anzeigen

@ -3,96 +3,112 @@
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"char": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"find": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"format": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"gmatch": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"gsub": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"len": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"lower": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"match": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"pack": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"packsize": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"rep": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"reverse": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"sub": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"unpack": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"upper": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
}
}

18
manual/luadoc/table.json
Datei anzeigen

@ -9,36 +9,42 @@
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"pack": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"unpack": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"remove": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"move": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
},
"sort": {
"is_lua_builtin": true,
"type": "function",
"parameters": [],
"return_values": 0
"return_values": 0,
"since": "0.1"
}
}