Update docstrings

master
Jordan Irwin 2017-08-18 12:08:00 -07:00
parent 517dc89991
commit 807d1e3c55
2 changed files with 17 additions and 2 deletions

11
api.lua
View File

@ -1,5 +1,9 @@
-- Functions for slingshot mod
--- Slingshot mod API.
--
-- @module api
-- Displays mod name in square brackets at beginning of log messages
local log_header = '[' .. slingshot.modname .. '] '
@ -121,7 +125,7 @@ end
--
-- @function slingshot.register
-- @tparam string name Name of the slingshot (e.g. ***"iron"***).
-- @tparam table def Slingshot definition table (see [slingshot.register.def][]).
-- @tparam table def Slingshot definition table (see [slingshot.register.def](#slingshot.register.def)).
function slingshot.register(name, def)
if def.inventory_image then
-- Inventory image will override image if set
@ -195,6 +199,10 @@ function slingshot.register(name, def)
end
--- Function Definition Tables.
--
-- @section fdtables
--- Slingshot definition table.
--
-- @table slingshot.register.def
@ -207,3 +215,4 @@ end
-- @tfield table recipe A custom recipe to use for crafting.
-- @tfield string ingredient Creates a standard craft recipe using this ingredient (overrides ***recipe***).
-- @tfield table aliases List of item names that should be uses as aliases for this slingshot.
-- @see slingshot.register

View File

@ -1,7 +1,13 @@
-- Slingshot settings
--- Slingshot mod settings.
--
-- @module settings
--- Requires rubber band for slingshot craft recipe.
--- Require rubber band for slingshot craft recipe.
--
-- @setting slingshot.require_rubber_band
-- @settype bool
-- @default true
slingshot.require_rubber_band = core.settings:get_bool('slingshot.require_rubber_band') ~= false