From 0ffdb47b54b4af5d94f48020437331c5f6e531b8 Mon Sep 17 00:00:00 2001 From: VorTechnix <45538536+VorTechnix@users.noreply.github.com> Date: Wed, 16 Oct 2024 19:57:55 -0700 Subject: [PATCH] more doc refixes --- .../utils/notify/validate.lua | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/worldeditadditions_core/utils/notify/validate.lua b/worldeditadditions_core/utils/notify/validate.lua index dadba2a..91a29cc 100644 --- a/worldeditadditions_core/utils/notify/validate.lua +++ b/worldeditadditions_core/utils/notify/validate.lua @@ -13,8 +13,8 @@ end local validate = {} --- Validate name --- @param string name The name of the player to validate. --- @returns boolean True if the name is valid, false otherwise. +-- @param name string The name of the player to validate. +-- @returns boolean True if the name is valid, false otherwise. validate.name = function(name) if type(name) ~= "string" then log_error(tostring(name) .. " is a " .. type(name) .. " not a string.\n") @@ -30,13 +30,13 @@ validate.name = function(name) end --- Validate message --- @param string message The message to validate. --- @returns boolean True if the message is a string, false otherwise. +-- @param message string The message to validate. +-- @returns boolean True if the message is a string, false otherwise. validate.message = function(message) return type(message) == "string" end --- Validate colour --- @param string colour The colour to validate. --- @returns boolean True if the colour is valid, false otherwise. +-- @param colour string The colour to validate. +-- @returns boolean True if the colour is valid, false otherwise. validate.colour = function(colour) return ( type(colour) == "string" and colour:match("^#%x+$") and @@ -44,9 +44,9 @@ validate.colour = function(colour) end --- Validate all --- @param string name The name of the player to validate. --- @param string message The message to validate. --- @param string colour The colour to validate. +-- @param name string The name of the player to validate. +-- @param message string The message to validate. +-- @param colour string The colour to validate. -- @returns boolean, table|nil Returns the validation status, followed by details of the failure if bool == false. -- | Return arg | Meaning | -- |------------|---------|