summaryrefslogtreecommitdiff
path: root/ldoc-stubs/backstack.lua
diff options
context:
space:
mode:
authorjacqueline <me@jacqueline.id.au>2024-03-07 17:22:06 +1100
committerjacqueline <me@jacqueline.id.au>2024-03-07 17:22:06 +1100
commit36a19182bec171d6376e51f5689aaf70b9d6fbad (patch)
treeb75be5f1567510ce2c60693c978a6ddf0b879905 /ldoc-stubs/backstack.lua
parentbeb1f654958c28429323fcb9622c9c8d206979a3 (diff)
downloadtangara-fw-36a19182bec171d6376e51f5689aaf70b9d6fbad.tar.gz
Use luals-stubs as the source of truth for docs, instead of maintaining
separate docs stubs Includes introducing a cool new script to turn lua-language-server's json output into markdown documentation.
Diffstat (limited to 'ldoc-stubs/backstack.lua')
-rw-r--r--ldoc-stubs/backstack.lua13
1 files changed, 0 insertions, 13 deletions
diff --git a/ldoc-stubs/backstack.lua b/ldoc-stubs/backstack.lua
deleted file mode 100644
index d4807d37..00000000
--- a/ldoc-stubs/backstack.lua
+++ /dev/null
@@ -1,13 +0,0 @@
---- Module for adding and removing screens from the system's backstack.
--- @module backstack
-
-local backstack = {}
-
---- Pushes a new screen onto the backstack.
--- @tparam function constructor Called to create the UI for the new screen. A new default root object and group will be set before calling this function. The function provided should return a table holding any bindings used by this screen; the returned value is retained so long as this screen is present in the backstack.
-function backstack.push(constructor) end
-
---- Removes the currently active screen, and instead shows the screen underneath it on the backstack. Does nothing if this is the only existing screen.
-function backstack.pop() end
-
-return backstack