From 3f16379a67138a45bcd086ee4f36cff2f60f1dda Mon Sep 17 00:00:00 2001 From: "Y. Wang" Date: Thu, 3 Nov 2022 19:53:30 +0100 Subject: Add documentation --- advtrains/l10n.lua | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/advtrains/l10n.lua b/advtrains/l10n.lua index 3eb75c9..be39587 100644 --- a/advtrains/l10n.lua +++ b/advtrains/l10n.lua @@ -1,5 +1,23 @@ +--- Advtrains l10n module. +-- Advtrains' l10n module is built on top of +-- [Minetest's](https://minetest.gitlab.io/minetest/translations/). +-- @module attrans +-- @alias mt + +--- Wrapper for `minetest.translate`. +-- Note that this function is also called when calling the `attrans` +-- *table* itself. Doing so is encourged as `attrans.attrans` is only +-- intended for situations where only functions are accepted. +-- @function attrans +-- @param str The string to translate. +-- @param[opt] ... Additional arguments to pass to `minetest.translate`. local S = minetest.get_translator("advtrains") +--- Generate an error message that a user does not have a specific privilege. +-- @function nopriv +-- @param priv The privilege that is missing. +-- @param[opt] verb The action that is denied. +-- @param[optchain] ... Additional arguments to pass to `minetest.translate`. local function S_nopriv(priv, verb, ...) if verb then return S(string.format("You are not allowed to %s without the %s privilege.", verb, priv), ...) @@ -15,6 +33,7 @@ local mt = { } attrans = { + attrans = S, nopriv = S_nopriv, } setmetatable(attrans, mt) -- cgit v1.2.3