Fix invalid @realm tags

This commit is contained in:
peelz
2022-08-03 21:34:42 -04:00
parent 7e99cdef29
commit e0defa82e2
2 changed files with 12 additions and 3 deletions

View File

@@ -25,7 +25,7 @@ Game.ServerSettings = true
Game.Settings = true
--- ChatBox.
-- @realm ChatBox
-- @realm server
Game.ChatBox = true
--- Send chat message to every client.

View File

@@ -23,13 +23,22 @@ function ldoc.asset_url(path)
end
function ldoc.realm_icon(realm)
assert(
realm == "server" or realm == "client" or realm == "shared",
string.format("WARNING: invalid realm '%s'", realm))
return "<span class=\"realm " .. (realm or "") .. "\"></span>"
end
function ldoc.realm_icon_from_item(item)
local realm = item.tags.realm
assert(type(realm) == "table" and #realm > 0, "missing @realm tag")
return ldoc.realm_icon(realm[1])
end
function ldoc.sidebar_item(item, module)
local text = ""
text = text .. ldoc.realm_icon(item.tags.realm[1])
text = text .. ldoc.realm_icon_from_item(item)
text = text .. "<a href=\""
.. ldoc.ref_to_module(module) .. "#" .. item.name
.. "\">"
@@ -66,7 +75,7 @@ function ldoc.item_header(item)
end
text = text
.. ldoc.realm_icon(item.tags.realm[1])
.. ldoc.realm_icon_from_item(item)
.. ldoc.display_name(item)
.. "</h1>"
.. "</a>"