diff --git a/files/data/openmw_aux/calendar.lua b/files/data/openmw_aux/calendar.lua index 7dba60dbeb..2ba7a47f27 100644 --- a/files/data/openmw_aux/calendar.lua +++ b/files/data/openmw_aux/calendar.lua @@ -2,6 +2,7 @@ -- `openmw_aux.calendar` defines utility functions for formatting game time. -- Implementation can be found in `resources/vfs/openmw_aux/calendar.lua`. -- @module calendar +-- @context global|menu|local -- @usage local calendar = require('openmw_aux.calendar') local core = require('openmw.core') diff --git a/files/data/openmw_aux/time.lua b/files/data/openmw_aux/time.lua index 1c543c53b8..d7f18b2795 100644 --- a/files/data/openmw_aux/time.lua +++ b/files/data/openmw_aux/time.lua @@ -2,6 +2,7 @@ -- `openmw_aux.time` defines utility functions for timers. -- Implementation can be found in `resources/vfs/openmw_aux/time.lua`. -- @module time +-- @context global|menu|local -- @usage local time = require('openmw_aux.time') local time = { diff --git a/files/data/openmw_aux/ui.lua b/files/data/openmw_aux/ui.lua index cadae2a033..2c1a138d11 100644 --- a/files/data/openmw_aux/ui.lua +++ b/files/data/openmw_aux/ui.lua @@ -4,6 +4,7 @@ local ui = require('openmw.ui') -- `openmw_aux.ui` defines utility functions for UI. -- Implementation can be found in `resources/vfs/openmw_aux/ui.lua`. -- @module ui +-- @context menu|player -- @usage local auxUi = require('openmw_aux.ui') local aux_ui = {} diff --git a/files/data/openmw_aux/util.lua b/files/data/openmw_aux/util.lua index b360383066..ca4fe7ed31 100644 --- a/files/data/openmw_aux/util.lua +++ b/files/data/openmw_aux/util.lua @@ -2,6 +2,7 @@ -- `openmw_aux.util` defines utility functions that are implemented in Lua rather than in C++. -- Implementation can be found in `resources/vfs/openmw_aux/util.lua`. -- @module util +-- @context global|menu|local -- @usage local aux_util = require('openmw_aux.util') local aux_util = {} diff --git a/files/data/scripts/omw/activationhandlers.lua b/files/data/scripts/omw/activationhandlers.lua index a70696824f..419ffe6809 100644 --- a/files/data/scripts/omw/activationhandlers.lua +++ b/files/data/scripts/omw/activationhandlers.lua @@ -60,6 +60,7 @@ return { interfaceName = 'Activation', --- -- @module Activation + -- @context global -- @usage require('openmw.interfaces').Activation interface = { --- Interface version diff --git a/files/data/scripts/omw/ai.lua b/files/data/scripts/omw/ai.lua index d2b248f761..e44958c725 100644 --- a/files/data/scripts/omw/ai.lua +++ b/files/data/scripts/omw/ai.lua @@ -58,6 +58,7 @@ return { interfaceName = 'AI', --- Basic AI interface -- @module AI + -- @context local -- @usage require('openmw.interfaces').AI interface = { --- Interface version diff --git a/files/data/scripts/omw/camera/camera.lua b/files/data/scripts/omw/camera/camera.lua index 5cd04239f7..6730e0c069 100644 --- a/files/data/scripts/omw/camera/camera.lua +++ b/files/data/scripts/omw/camera/camera.lua @@ -239,6 +239,7 @@ return { interfaceName = 'Camera', --- -- @module Camera + -- @context player -- @usage require('openmw.interfaces').Camera interface = { --- Interface version is 1 diff --git a/files/data/scripts/omw/crimes.lua b/files/data/scripts/omw/crimes.lua index 8539471973..ae6612b34f 100644 --- a/files/data/scripts/omw/crimes.lua +++ b/files/data/scripts/omw/crimes.lua @@ -20,6 +20,7 @@ return { --- -- Allows to utilize built-in crime mechanics. -- @module Crimes + -- @context global -- @usage require('openmw.interfaces').Crimes interface = { --- Interface version diff --git a/files/data/scripts/omw/input/gamepadcontrols.lua b/files/data/scripts/omw/input/gamepadcontrols.lua index 1f944fc708..9b89d505b5 100644 --- a/files/data/scripts/omw/input/gamepadcontrols.lua +++ b/files/data/scripts/omw/input/gamepadcontrols.lua @@ -6,6 +6,7 @@ return { --- -- Gamepad control interface -- @module GamepadControls + -- @context player -- @usage require('openmw.interfaces').GamepadControls interface = { --- Interface version diff --git a/files/data/scripts/omw/input/playercontrols.lua b/files/data/scripts/omw/input/playercontrols.lua index 244b952a1a..862fa33452 100644 --- a/files/data/scripts/omw/input/playercontrols.lua +++ b/files/data/scripts/omw/input/playercontrols.lua @@ -250,6 +250,7 @@ return { interfaceName = 'Controls', --- -- @module Controls + -- @context player -- @usage require('openmw.interfaces').Controls interface = { --- Interface version diff --git a/files/data/scripts/omw/mechanics/animationcontroller.lua b/files/data/scripts/omw/mechanics/animationcontroller.lua index c7a9182a8e..91cb60d177 100644 --- a/files/data/scripts/omw/mechanics/animationcontroller.lua +++ b/files/data/scripts/omw/mechanics/animationcontroller.lua @@ -60,6 +60,7 @@ return { --- -- Animation controller interface -- @module AnimationController + -- @context local -- @usage local anim = require('openmw.animation') -- local I = require('openmw.interfaces') -- diff --git a/files/data/scripts/omw/mwui/init.lua b/files/data/scripts/omw/mwui/init.lua index 5ab2d3cb23..253260d063 100644 --- a/files/data/scripts/omw/mwui/init.lua +++ b/files/data/scripts/omw/mwui/init.lua @@ -46,6 +46,7 @@ local templatesMeta = { --- -- @module MWUI +-- @context menu|player -- @usage require('openmw.interfaces').MWUI local function TemplateOverrides(templates) return setmetatable({ diff --git a/files/data/scripts/omw/settings/player.lua b/files/data/scripts/omw/settings/player.lua index 0ae607df0b..552a50043a 100644 --- a/files/data/scripts/omw/settings/player.lua +++ b/files/data/scripts/omw/settings/player.lua @@ -40,6 +40,7 @@ return { interfaceName = 'Settings', --- -- @module Settings + -- @context global|menu|player -- @usage -- -- In a player script -- local storage = require('openmw.storage') diff --git a/files/data/scripts/omw/skillhandlers.lua b/files/data/scripts/omw/skillhandlers.lua index 26fff6e799..d3a224dc46 100644 --- a/files/data/scripts/omw/skillhandlers.lua +++ b/files/data/scripts/omw/skillhandlers.lua @@ -153,6 +153,7 @@ return { --- -- Allows to extend or override built-in skill progression mechanics. -- @module SkillProgression + -- @context local -- @usage local I = require('openmw.interfaces') -- -- -- Forbid increasing destruction skill past 50 diff --git a/files/data/scripts/omw/ui.lua b/files/data/scripts/omw/ui.lua index 1e76b8e141..e29bbe254e 100644 --- a/files/data/scripts/omw/ui.lua +++ b/files/data/scripts/omw/ui.lua @@ -159,6 +159,7 @@ return { interfaceName = 'UI', --- -- @module UI + -- @context player -- @usage require('openmw.interfaces').UI interface = { --- Interface version diff --git a/files/data/scripts/omw/usehandlers.lua b/files/data/scripts/omw/usehandlers.lua index 563e31b3b7..cf976994be 100644 --- a/files/data/scripts/omw/usehandlers.lua +++ b/files/data/scripts/omw/usehandlers.lua @@ -36,6 +36,7 @@ return { -- * can't intercept actions performed by the AI (i.e. drinking a potion in combat); -- * can't intercept actions performed via quick keys menu. -- @module ItemUsage + -- @context global -- @usage local I = require('openmw.interfaces') -- -- -- Override Use action (global script).