Skip to content

Commit

Permalink
Function Name Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
bleonheart authored May 28, 2024
1 parent d7523c5 commit bf6c06e
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 27 deletions.
36 changes: 14 additions & 22 deletions config.ld
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,16 @@ file = {
}

dir = "docs/html"
project = "Skeleton Schema Documentation"
title = "Skeleton Schema Documentation"
project = "Skeleton"
title = "Skeleton Documentation"
no_space_before_args = true
style = "docs/css"
template = "docs/templates"
format = "markdown"
ignore = true
topics = "docs/manual"
use_markdown_titles = true
kind_names = {module = "Libraries", topic = "Manual"}
kind_names = {module = "Core - Libraries", topic = "Core - Manual"}
merge = true
sort = true
sort_modules = true
Expand All @@ -28,26 +29,17 @@ custom_tags = {
{"internal", hidden = true}
}

custom_display_name_handler = function(item, default_handler)
if (item.type == "function" and item.module) then
if (item.module.type == "classmod" or item.module.type == "panel" or item.module.type == "configurations") then
return item.module.mod_name .. ":" .. default_handler(item)
elseif (item.module.type == "hooks") then
return item.module.mod_name:upper() .. ":" .. default_handler(item)

end
end
new_type("structureitems", "Structures - Items", true)
new_type("structurefactions", "Structures - Factions", true)
new_type("structureclasses", "Structures - Classes", true)
new_type("structurecommands", "Structures - Commands", true)
new_type("structuremodule", "Structures - Module", true)
new_type("configurationmodule", "Config - Module", true)
new_type("configurationgeneral", "Config - General", true)
new_type("hooksgeneral", "Hooks - General", true)
new_type("hooksmodule", "Hooks - Module", true)
new_type("panels", "UI - Panels", true)

return default_handler(item)
end


new_type("hooks", "Hooks", true)
new_type("items", "Items", true)
new_type("classes", "Classes", true)
new_type("factions", "Factions", true)
new_type("configurations", "Configurations", true)
new_type("panel", "Panels", true)
tparam_alias("inventory", "Inventory")
tparam_alias("item", "Item")
tparam_alias("date", "date")
Expand Down
2 changes: 1 addition & 1 deletion skeleton/schema/config/shared.lua
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Lilia's configuration options.
This is meant to override Lilia's configuration options.
]]
-- @configurations Lilia
-- @configurationgeneral Lilia

--- A list of available commands for use within the game.
-- Each command is represented by a table with fields defining its functionality.
Expand Down
2 changes: 1 addition & 1 deletion skeleton/schema/factions/custom.lua
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
--- Attributes of the custom faction.
-- @factions Custom
-- @structurefactions Custom

--- A list of the current fields in the faction.
-- @realm shared
Expand Down
2 changes: 1 addition & 1 deletion skeleton/schema/factions/default.lua
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
--- Attributes of the default faction.
-- @factions Default
-- @structurefactions Default

--- A list of the current fields in the faction.
-- @realm shared
Expand Down
2 changes: 1 addition & 1 deletion skeleton/schema/items/universalammo.lua
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
--- Structure of UniversalAmmunition Item.
-- @items UniversalAmmunition
-- @structureitems UniversalAmmunition

--- This table defines the fields of the universal ammo item.
-- @table Configurations
Expand Down
2 changes: 1 addition & 1 deletion skeleton/schema/schema.lua
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This is meant to define the Schema's default information.
]]
-- @configurations Schema
-- @configurationgeneral Schema

--- A list of schema fields that define the gamemode you are making.
-- These options are defined by the 'SCHEMA' table.
Expand Down

0 comments on commit bf6c06e

Please sign in to comment.