feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Lua: Update documentation

Browse Source 
Change-Id: I998196730ddc24a8377606b23f6f64cced806c1a
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Marcus Tillmanns
2025-02-13 12:14:49 +01:00
parent 92b0256bd3
commit 93bebe1917
1 changed files with 6 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
doc/qtcreatordev/src/lua-extensions.qdoc
View File

@@ -25,18 +25,19 @@
\code \code
--- MyExtension.lua --- MyExtension.lua
return { return {
Id = "myextension",
Name = "MyExtension", Name = "MyExtension",
Version = "1.0.0", Version = "1.0.0",
CompatVersion = "1.0.0", CompatVersion = "1.0.0",
Vendor = "My Company", Vendor = "My Company",
VendorId = "mycompany",
Category = "Tests", Category = "Tests",
Description = "Describe what your extension does in a sentence.", Description = "Describe what your extension does in a sentence.",
LongDescription = [[ LongDescription = [[
Tell users more about your extension. Tell users more about your extension. This text is rendered as Markdown.
]], ]],
Dependencies = { Dependencies = {
{ Name = "Core", Version = "13.0.82", Required = true }, { Name = "Lua", Version = "15.0.0", Required = true }
{ Name = "Lua", Version = "13.0.82", Required = true }
}, },
setup = function() print("Hello from Lua!") end, setup = function() print("Hello from Lua!") end,
printToOutputPane = true, printToOutputPane = true,
@@ -125,7 +126,7 @@
void initialize() final { void initialize() final {
// The registered function will be called when the Lua module 'MyCppExtension' is required. // 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. // 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(); sol::table result = lua.create_table();
result["myFunction"] = [](int a, int b) { return a + b; }; result["myFunction"] = [](int a, int b) { return a + b; };
return result; return result;
@@ -139,7 +140,7 @@
\code \code
local MyCppExtension = require 'MyCppExtension' local MyCppExtension = require 'MyCppExtension'
--- MyCppExtension is now a table with a single field 'myFunction', as it is returned from the --- 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)) print(MyCppExtension.myFunction(1, 2))
\endcode \endcode
@@ -271,5 +272,3 @@
\quotefile ../../../src/plugins/lua/meta/utils.lua \quotefile ../../../src/plugins/lua/meta/utils.lua
*/ */