aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorAlexander M Pickering <alex@cogarr.net>2021-10-27 01:04:47 -0500
committerAlexander M Pickering <alex@cogarr.net>2021-10-27 01:04:47 -0500
commit182f17566580e7ac3e332f99d233df3c1c8b399e (patch)
tree332f8667cf85d57bd1d5f9896f9b2e61df0b2f6b /src
parentb29ade63e3e6b4b3b163907e391f2968193ba7be (diff)
downloadbrokengine-182f17566580e7ac3e332f99d233df3c1c8b399e.tar.gz
brokengine-182f17566580e7ac3e332f99d233df3c1c8b399e.tar.bz2
brokengine-182f17566580e7ac3e332f99d233df3c1c8b399e.zip
Add documentation
Diffstat (limited to 'src')
-rw-r--r--src/client/lua_api/gui/iguispinbox.cpp6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/client/lua_api/gui/iguispinbox.cpp b/src/client/lua_api/gui/iguispinbox.cpp
index 25ecbde..a431396 100644
--- a/src/client/lua_api/gui/iguispinbox.cpp
+++ b/src/client/lua_api/gui/iguispinbox.cpp
@@ -19,10 +19,10 @@ using namespace gui;
extern IrrlichtDevice* device;
/***
-@function gui.newspinbox()
Creates a new spinbox
-@tparam rect dimensions The rectangle to place the button at. If the box has a parent,
-it is offset from the upper-left of the parent element.
+Creates a gui element that has up and down arrows to control the value, and is editable by the user.
+@function gui.newspinbox()
+@tparam rect dimensions The rectangle to place the button at. If the box has a parent, it is offset from the upper-left of the parent element.
@tparam? string default_text The default text to display in the spinbox.
@tparam? iguielement parent The parent element of the button.
@tparam? boolean border Display a border around the spinbox