Partydeck/Druid-Extension
3
0
Fork 0
mirror of https://github.com/Insality/druid synced 2025-06-27 10:27:48 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add update docs scripts, updated docs

Browse Source
This commit is contained in:
Insality 2020-10-12 00:45:42 +03:00
parent cebba9a1a3
commit 22f947859a
26 changed files with 58 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
annotations.lua
View File

@ -338,25 +338,25 @@
---@field create fun(self:druid_instance, component:Component, ...:args) Create new druid component
---@field final fun(self:druid_instance) Call on final function on gui_script.
---@field initialize fun(self:druid_instance, context:table, style:table) Druid class constructor
---@field new_back_handler fun(self:druid_instance, ...:args):Component Create back_handler basic component
---@field new_blocker fun(self:druid_instance, ...:args):Component Create blocker basic component
---@field new_button fun(self:druid_instance, ...:args):Component Create button basic component
---@field new_checkbox fun(self:druid_instance, ...:args):Component Create checkbox component
---@field new_checkbox_group fun(self:druid_instance, ...:args):Component Create checkbox_group component
---@field new_drag fun(self:druid_instance, ...:args):Componetn Create drag basic component
---@field new_dynamic_grid fun(self:druid_instance, ...:args):Component Create dynamic grid component
---@field new_grid fun(self:druid_instance, ...:args):Component Create grid basic component Deprecated
---@field new_hover fun(self:druid_instance, ...:args):Component Create hover basic component
---@field new_input fun(self:druid_instance, ...:args):Component Create input component
---@field new_lang_text fun(self:druid_instance, ...:args):Component Create lang_text component
---@field new_progress fun(self:druid_instance, ...:args):Component Create progress component
---@field new_radio_group fun(self:druid_instance, ...:args):Component Create radio_group component
---@field new_scroll fun(self:druid_instance, ...:args):Component Create scroll basic component
---@field new_slider fun(self:druid_instance, ...:args):Component Create slider component
---@field new_static_grid fun(self:druid_instance, ...:args):Component Create static grid basic component
---@field new_swipe fun(self:druid_instance, ...:args):Component Create swipe basic component
---@field new_text fun(self:druid_instance, ...:args):Component Create text basic component
---@field new_timer fun(self:druid_instance, ...:args):Component Create timer component
---@field new_back_handler fun(self:druid_instance, ...:args):druid.back_handler Create back_handler basic component
---@field new_blocker fun(self:druid_instance, ...:args):druid.blocker Create blocker basic component
---@field new_button fun(self:druid_instance, ...:args):druid.button Create button basic component
---@field new_checkbox fun(self:druid_instance, ...:args):druid.checkbox Create checkbox component
---@field new_checkbox_group fun(self:druid_instance, ...:args):druid.checkbox_group Create checkbox_group component
---@field new_drag fun(self:druid_instance, ...:args):druid.drag Create drag basic component
---@field new_dynamic_grid fun(self:druid_instance, ...:args):druid.dynamic_grid Create dynamic grid component
---@field new_grid fun(self:druid_instance, ...:args):druid.static_grid Create grid basic component Deprecated
---@field new_hover fun(self:druid_instance, ...:args):druid.hover Create hover basic component
---@field new_input fun(self:druid_instance, ...:args):druid.input Create input component
---@field new_lang_text fun(self:druid_instance, ...:args):druid.lang_text Create lang_text component
---@field new_progress fun(self:druid_instance, ...:args):druid.progress Create progress component
---@field new_radio_group fun(self:druid_instance, ...:args):druid.radio_group Create radio_group component
---@field new_scroll fun(self:druid_instance, ...:args):druid.scroll Create scroll basic component
---@field new_slider fun(self:druid_instance, ...:args):druid.slider Create slider component
---@field new_static_grid fun(self:druid_instance, ...:args):druid.static_grid Create static grid basic component
---@field new_swipe fun(self:druid_instance, ...:args):druid.swipe Create swipe basic component
---@field new_text fun(self:druid_instance, ...:args):Tet Create text basic component
---@field new_timer fun(self:druid_instance, ...:args):druid.timer Create timer component
---@field on_focus_gained fun(self:druid_instance) Druid on focus gained interest function.
---@field on_focus_lost fun(self:druid_instance) Druid on focus lost interest function.
---@field on_input fun(self:druid_instance, action_id:hash, action:table) Druid on_input function

2
docs/index.html
View File

@ -164,7 +164,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-10-12 00:29:49 </i>
<i style="float:right;">Last updated 2020-10-12 00:44:30 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/BackHandler.html
View File

@ -189,7 +189,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-10-12 00:29:49 </i>
<i style="float:right;">Last updated 2020-10-12 00:44:30 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/BaseComponent.html
View File

@ -472,7 +472,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-10-12 00:29:49 </i>
<i style="float:right;">Last updated 2020-10-12 00:44:30 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/Blocker.html
View File

@ -179,7 +179,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-10-12 00:29:49 </i>
<i style="float:right;">Last updated 2020-10-12 00:44:30 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/Button.html
View File

@ -688,7 +688,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-10-12 00:29:49 </i>
<i style="float:right;">Last updated 2020-10-12 00:44:30 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/Checkbox.html
View File

@ -308,7 +308,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-10-12 00:29:49 </i>
<i style="float:right;">Last updated 2020-10-12 00:44:30 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/CheckboxGroup.html
View File

@ -220,7 +220,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-10-12 00:29:49 </i>
<i style="float:right;">Last updated 2020-10-12 00:44:30 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/Drag.html
View File

@ -464,7 +464,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-10-12 00:29:49 </i>
<i style="float:right;">Last updated 2020-10-12 00:44:30 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/DruidEvent.html
View File

@ -262,7 +262,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-10-12 00:29:49 </i>
<i style="float:right;">Last updated 2020-10-12 00:44:30 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/DruidInstance.html
View File

@ -1103,7 +1103,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-10-12 00:29:49 </i>
<i style="float:right;">Last updated 2020-10-12 00:44:30 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/DynamicGrid.html
View File

@ -683,7 +683,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-10-12 00:29:49 </i>
<i style="float:right;">Last updated 2020-10-12 00:44:30 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/Hover.html
View File

@ -305,7 +305,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-10-12 00:29:49 </i>
<i style="float:right;">Last updated 2020-10-12 00:44:30 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/Input.html
View File

@ -608,7 +608,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-10-12 00:29:49 </i>
<i style="float:right;">Last updated 2020-10-12 00:44:30 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/LangText.html
View File

@ -218,7 +218,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-10-12 00:29:49 </i>
<i style="float:right;">Last updated 2020-10-12 00:44:30 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/Progress.html
View File

@ -497,7 +497,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-10-12 00:29:49 </i>
<i style="float:right;">Last updated 2020-10-12 00:44:30 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/RadioGroup.html
View File

@ -220,7 +220,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-10-12 00:29:49 </i>
<i style="float:right;">Last updated 2020-10-12 00:44:30 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/Scroll.html
View File

@ -1008,7 +1008,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-10-12 00:29:49 </i>
<i style="float:right;">Last updated 2020-10-12 00:44:30 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/Slider.html
View File

@ -396,7 +396,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-10-12 00:29:49 </i>
<i style="float:right;">Last updated 2020-10-12 00:44:30 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/StaticGrid.html
View File

@ -732,7 +732,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-10-12 00:29:49 </i>
<i style="float:right;">Last updated 2020-10-12 00:44:30 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/Swipe.html
View File

@ -258,7 +258,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-10-12 00:29:49 </i>
<i style="float:right;">Last updated 2020-10-12 00:44:30 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/Text.html
View File

@ -586,7 +586,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-10-12 00:29:49 </i>
<i style="float:right;">Last updated 2020-10-12 00:44:30 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/Timer.html
View File

@ -378,7 +378,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-10-12 00:29:49 </i>
<i style="float:right;">Last updated 2020-10-12 00:44:30 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/druid.helper.html
View File

@ -312,7 +312,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-10-12 00:29:49 </i>
<i style="float:right;">Last updated 2020-10-12 00:44:30 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

2
docs/modules/druid.html
View File

@ -313,7 +313,7 @@
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2020-10-12 00:29:49 </i>
<i style="float:right;">Last updated 2020-10-12 00:44:30 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>

15
update_docs.sh Executable file
View File

@ -0,0 +1,15 @@
#!/bin/bash
## I am using Ldoc and my own Ldoc -> emmylua generator:
## https://github.com/Insality/emmylua-from-ldoc-annotations
emmylua_generator_path=~/code/lua/emmylua-from-ldoc-annotations
echo "Update Ldoc"
ldoc .
echo ""
echo "Update EmmyLua annotations"
original_path=$(pwd)
bash $emmylua_generator_path/export.sh $original_path
mv $emmylua_generator_path/annotations.lua $original_path/annotations.lua