aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarcus Tillmanns <[email protected]>2025-02-13 12:14:49 +0100
committerMarcus Tillmanns <[email protected]>2025-02-13 11:59:25 +0000
commit93bebe1917a84420eb2be91e6ca7cf42869aff01 (patch)
tree07b505d977365ea36538defd98851f9b8cb00264
parent92b0256bd34796a85832c3133026224fad878dcf (diff)
Lua: Update documentation
Change-Id: I998196730ddc24a8377606b23f6f64cced806c1a Reviewed-by: Eike Ziller <[email protected]>
-rw-r--r--doc/qtcreatordev/src/lua-extensions.qdoc13
1 files changed, 6 insertions, 7 deletions
diff --git a/doc/qtcreatordev/src/lua-extensions.qdoc b/doc/qtcreatordev/src/lua-extensions.qdoc
index 581db2e3922..44e49b275f8 100644
--- a/doc/qtcreatordev/src/lua-extensions.qdoc
+++ b/doc/qtcreatordev/src/lua-extensions.qdoc
@@ -25,18 +25,19 @@
\code
--- MyExtension.lua
return {
+ Id = "myextension",
Name = "MyExtension",
Version = "1.0.0",
CompatVersion = "1.0.0",
Vendor = "My Company",
+ VendorId = "mycompany",
Category = "Tests",
Description = "Describe what your extension does in a sentence.",
LongDescription = [[
- Tell users more about your extension.
+ Tell users more about your extension. This text is rendered as Markdown.
]],
Dependencies = {
- { Name = "Core", Version = "13.0.82", Required = true },
- { Name = "Lua", Version = "13.0.82", Required = true }
+ { Name = "Lua", Version = "15.0.0", Required = true }
},
setup = function() print("Hello from Lua!") end,
printToOutputPane = true,
@@ -125,7 +126,7 @@
void initialize() final {
// The registered function will be called when the Lua module 'MyCppExtension' is required.
// The returned table will be returned from the require call in Lua.
- ::Lua::LuaEngine::registerProvider("MyCppExtension", [](sol::state_view lua) -> sol::object {
+ ::Lua::registerProvider("MyCppExtension", [](sol::state_view lua) -> sol::object {
sol::table result = lua.create_table();
result["myFunction"] = [](int a, int b) { return a + b; };
return result;
@@ -139,7 +140,7 @@
\code
local MyCppExtension = require 'MyCppExtension'
--- MyCppExtension is now a table with a single field 'myFunction', as it is returned from the
- --- C++ function registered via 'LuaEngine::registerProvider(...)'.
+ --- C++ function registered via 'Lua::registerProvider(...)'.
print(MyCppExtension.myFunction(1, 2))
\endcode
@@ -271,5 +272,3 @@
\quotefile ../../../src/plugins/lua/meta/utils.lua
*/
-
-