From bf6c06ef8b1752ea0ac0c5ab3da2dfa6c3fc4031 Mon Sep 17 00:00:00 2001 From: Leonheart <33399712+bleonheart@users.noreply.github.com> Date: Tue, 28 May 2024 10:20:15 +0100 Subject: [PATCH] Function Name Updates --- config.ld | 36 ++++++++++--------------- skeleton/schema/config/shared.lua | 2 +- skeleton/schema/factions/custom.lua | 2 +- skeleton/schema/factions/default.lua | 2 +- skeleton/schema/items/universalammo.lua | 2 +- skeleton/schema/schema.lua | 2 +- 6 files changed, 19 insertions(+), 27 deletions(-) diff --git a/config.ld b/config.ld index 8fdd78d..83169d4 100644 --- a/config.ld +++ b/config.ld @@ -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 @@ -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") diff --git a/skeleton/schema/config/shared.lua b/skeleton/schema/config/shared.lua index 48baeae..4f4f04e 100644 --- a/skeleton/schema/config/shared.lua +++ b/skeleton/schema/config/shared.lua @@ -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. diff --git a/skeleton/schema/factions/custom.lua b/skeleton/schema/factions/custom.lua index 2a1093f..6518830 100644 --- a/skeleton/schema/factions/custom.lua +++ b/skeleton/schema/factions/custom.lua @@ -1,5 +1,5 @@ --- Attributes of the custom faction. --- @factions Custom +-- @structurefactions Custom --- A list of the current fields in the faction. -- @realm shared diff --git a/skeleton/schema/factions/default.lua b/skeleton/schema/factions/default.lua index e6784ec..b376ebd 100644 --- a/skeleton/schema/factions/default.lua +++ b/skeleton/schema/factions/default.lua @@ -1,5 +1,5 @@ --- Attributes of the default faction. --- @factions Default +-- @structurefactions Default --- A list of the current fields in the faction. -- @realm shared diff --git a/skeleton/schema/items/universalammo.lua b/skeleton/schema/items/universalammo.lua index ce19ea7..6f33d63 100644 --- a/skeleton/schema/items/universalammo.lua +++ b/skeleton/schema/items/universalammo.lua @@ -1,5 +1,5 @@ --- Structure of UniversalAmmunition Item. --- @items UniversalAmmunition +-- @structureitems UniversalAmmunition --- This table defines the fields of the universal ammo item. -- @table Configurations diff --git a/skeleton/schema/schema.lua b/skeleton/schema/schema.lua index f06017e..5192663 100644 --- a/skeleton/schema/schema.lua +++ b/skeleton/schema/schema.lua @@ -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.