From 7960d142ca3e28e0e4550faf131398899dca90dc Mon Sep 17 00:00:00 2001 From: Lukas Pioch Date: Fri, 7 Apr 2017 14:31:44 +0200 Subject: APIDoc: Corrected a few links --- Server/Plugins/APIDump/APIDesc.lua | 6 +++--- Server/Plugins/APIDump/Classes/WebAdmin.lua | 2 +- Server/Plugins/APIDump/Hooks/OnBrewingCompleted.lua | 4 ++-- Server/Plugins/APIDump/Hooks/OnBrewingCompleting.lua | 4 ++-- Server/Plugins/APIDump/main_APIDump.lua | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-) (limited to 'Server') diff --git a/Server/Plugins/APIDump/APIDesc.lua b/Server/Plugins/APIDump/APIDesc.lua index ee9e4cf30..9c017579c 100644 --- a/Server/Plugins/APIDump/APIDesc.lua +++ b/Server/Plugins/APIDump/APIDesc.lua @@ -11451,7 +11451,7 @@ a_Player:OpenWindow(Window); Type = "number", }, }, - Notes = "Returns the player's current set of skin part flags. This is a bitwise OR of various {{eSkinPart}} constants. Note that HasSkinPart may be easier to use in most situations.", + Notes = "Returns the player's current set of skin part flags. This is a bitwise OR of various {{Globals#eSkinPart|eSkinPart}} constants. Note that HasSkinPart may be easier to use in most situations.", }, GetStance = { @@ -12175,7 +12175,7 @@ a_Player:OpenWindow(Window); Type = "number", }, }, - Notes = "Sets the skin part flags of the player. The value should be a bitwise OR of several {{eSkinPart}} constants.", + Notes = "Sets the skin part flags of the player. The value should be a bitwise OR of several {{Globals#eSkinPart|eSkinPart}} constants.", }, SetSprintingMaxSpeed = { @@ -17197,7 +17197,7 @@ end These constants represent the main and off hand. Currently, these constants are not used, but are provided for future use when dual-wielding is functional. An action or item can be in the main hand or the off hand. The main hand can be either the left or the right hand - use - {{cPlayer}}:GetMainHand() to determine which (see {{eMainHand}}). + {{cPlayer}}:GetMainHand() to determine which (see {{Globals#eMainHand|eMainHand}}). ]], }, eMainHand = diff --git a/Server/Plugins/APIDump/Classes/WebAdmin.lua b/Server/Plugins/APIDump/Classes/WebAdmin.lua index f6ebe9da7..9eeb72c1c 100644 --- a/Server/Plugins/APIDump/Classes/WebAdmin.lua +++ b/Server/Plugins/APIDump/Classes/WebAdmin.lua @@ -23,7 +23,7 @@ return Type = "function", }, }, - Notes = "Adds a new web tab to webadmin. The tab uses \"Title\" as its display string and is identified in the URL using the UrlPath (https://server.domain.com/webadmin/{PluginName}/{UrlPath}). The HandlerFn is the callback function that is called when the admin accesses the page, it has the following signature:
function ({{a_Request|HTTPRequest}}, a_UrlPath)
  return Content, ContentType
end
URLPath must not contain a '/', the recommendation is to use only 7-bit-clean ASCII character set.", + Notes = "Adds a new web tab to webadmin. The tab uses \"Title\" as its display string and is identified in the URL using the UrlPath (https://server.domain.com/webadmin/{PluginName}/{UrlPath}). The HandlerFn is the callback function that is called when the admin accesses the page, it has the following signature:
function ({{HTTPRequest|a_Request}}, a_UrlPath)
  return Content, ContentType
end
URLPath must not contain a '/', the recommendation is to use only 7-bit-clean ASCII character set.", }, GetAllWebTabs = { diff --git a/Server/Plugins/APIDump/Hooks/OnBrewingCompleted.lua b/Server/Plugins/APIDump/Hooks/OnBrewingCompleted.lua index 316227739..93dbb036c 100644 --- a/Server/Plugins/APIDump/Hooks/OnBrewingCompleted.lua +++ b/Server/Plugins/APIDump/Hooks/OnBrewingCompleted.lua @@ -5,14 +5,14 @@ return CalledWhen = "A brewing process is completed.", DefaultFnName = "OnBrewingCompleted", -- also used as pagename Desc = [[ - This hook is called whenever a {{cBrewingstand|brewing stand}} has completed the brewing process. + This hook is called whenever a {{cBrewingstandEntity|brewing stand}} has completed the brewing process. See also the {{OnBrewingCompleting|HOOK_BREWING_COMPLETING}} hook for a similar hook, is called when a brewing process is completing. ]], Params = { { Name = "World", Type = "{{cWorld}}", Notes = "World where the brewing stand resides." }, - { Name = "Brewingstand", Type = "{{cBrewingstand}}", Notes = "The brewing stand that completed the brewing process." }, + { Name = "Brewingstand", Type = "{{cBrewingstandEntity}}", Notes = "The brewing stand that completed the brewing process." }, }, Returns = [[ If the function returns false or no value, Cuberite calls other plugins with this event. If the diff --git a/Server/Plugins/APIDump/Hooks/OnBrewingCompleting.lua b/Server/Plugins/APIDump/Hooks/OnBrewingCompleting.lua index 14429c8ff..6e4160d66 100644 --- a/Server/Plugins/APIDump/Hooks/OnBrewingCompleting.lua +++ b/Server/Plugins/APIDump/Hooks/OnBrewingCompleting.lua @@ -5,7 +5,7 @@ return CalledWhen = "A brewing process is completing.", DefaultFnName = "OnBrewingCompleting", -- also used as pagename Desc = [[ - This hook is called whenever a {{cBrewingstand|brewing stand}} is completing the brewing process. Plugins may + This hook is called whenever a {{cBrewingstandEntity|brewing stand}} is completing the brewing process. Plugins may refuse the completing of the brewing process.

See also the {{OnBrewingCompleted|HOOK_BREWING_COMPLETED}} hook for a similar hook, is called after the brewing process has been completed. @@ -13,7 +13,7 @@ return Params = { { Name = "World", Type = "{{cWorld}}", Notes = "World where the brewing stand resides." }, - { Name = "Brewingstand", Type = "{{cBrewingstand}}", Notes = "The brewing stand that completes the brewing process." }, + { Name = "Brewingstand", Type = "{{cBrewingstandEntity}}", Notes = "The brewing stand that completes the brewing process." }, }, Returns = [[ If the function returns false or no value, Cuberite calls other plugins with this event. If the function returns true, diff --git a/Server/Plugins/APIDump/main_APIDump.lua b/Server/Plugins/APIDump/main_APIDump.lua index b45f98a45..022fe9975 100644 --- a/Server/Plugins/APIDump/main_APIDump.lua +++ b/Server/Plugins/APIDump/main_APIDump.lua @@ -219,7 +219,7 @@ local function LinkifyString(a_String, a_Referrer) --- Creates the HTML for the specified link and title local function CreateLink(Link, Title) - if (Link:sub(1, 7) == "http://") then + if ((Link:sub(1, 7) == "http://") or (Link:sub(1, 8) == "https://")) then -- The link is a full absolute URL, do not modify, do not track: return "" .. Title .. ""; end -- cgit v1.2.3