From 22f947859a6ee42f4afdfe9581509c61f03c046d Mon Sep 17 00:00:00 2001 From: Insality Date: Mon, 12 Oct 2020 00:45:42 +0300 Subject: [PATCH] Add update docs scripts, updated docs --- annotations.lua | 38 ++++++++++++++++----------------- docs/index.html | 2 +- docs/modules/BackHandler.html | 2 +- docs/modules/BaseComponent.html | 2 +- docs/modules/Blocker.html | 2 +- docs/modules/Button.html | 2 +- docs/modules/Checkbox.html | 2 +- docs/modules/CheckboxGroup.html | 2 +- docs/modules/Drag.html | 2 +- docs/modules/DruidEvent.html | 2 +- docs/modules/DruidInstance.html | 2 +- docs/modules/DynamicGrid.html | 2 +- docs/modules/Hover.html | 2 +- docs/modules/Input.html | 2 +- docs/modules/LangText.html | 2 +- docs/modules/Progress.html | 2 +- docs/modules/RadioGroup.html | 2 +- docs/modules/Scroll.html | 2 +- docs/modules/Slider.html | 2 +- docs/modules/StaticGrid.html | 2 +- docs/modules/Swipe.html | 2 +- docs/modules/Text.html | 2 +- docs/modules/Timer.html | 2 +- docs/modules/druid.helper.html | 2 +- docs/modules/druid.html | 2 +- update_docs.sh | 15 +++++++++++++ 26 files changed, 58 insertions(+), 43 deletions(-) create mode 100755 update_docs.sh diff --git a/annotations.lua b/annotations.lua index f39db15..40b8244 100644 --- a/annotations.lua +++ b/annotations.lua @@ -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 diff --git a/docs/index.html b/docs/index.html index 75ef048..8062499 100644 --- a/docs/index.html +++ b/docs/index.html @@ -164,7 +164,7 @@
generated by LDoc 1.4.6 -Last updated 2020-10-12 00:29:49 +Last updated 2020-10-12 00:44:30
diff --git a/docs/modules/BackHandler.html b/docs/modules/BackHandler.html index 2cb578b..9a925d0 100644 --- a/docs/modules/BackHandler.html +++ b/docs/modules/BackHandler.html @@ -189,7 +189,7 @@
generated by LDoc 1.4.6 -Last updated 2020-10-12 00:29:49 +Last updated 2020-10-12 00:44:30
diff --git a/docs/modules/BaseComponent.html b/docs/modules/BaseComponent.html index 6587d03..635b273 100644 --- a/docs/modules/BaseComponent.html +++ b/docs/modules/BaseComponent.html @@ -472,7 +472,7 @@
generated by LDoc 1.4.6 -Last updated 2020-10-12 00:29:49 +Last updated 2020-10-12 00:44:30
diff --git a/docs/modules/Blocker.html b/docs/modules/Blocker.html index c3708dc..179cfda 100644 --- a/docs/modules/Blocker.html +++ b/docs/modules/Blocker.html @@ -179,7 +179,7 @@
generated by LDoc 1.4.6 -Last updated 2020-10-12 00:29:49 +Last updated 2020-10-12 00:44:30
diff --git a/docs/modules/Button.html b/docs/modules/Button.html index 83ee195..0a14166 100644 --- a/docs/modules/Button.html +++ b/docs/modules/Button.html @@ -688,7 +688,7 @@
generated by LDoc 1.4.6 -Last updated 2020-10-12 00:29:49 +Last updated 2020-10-12 00:44:30
diff --git a/docs/modules/Checkbox.html b/docs/modules/Checkbox.html index 4da4ed7..219384b 100644 --- a/docs/modules/Checkbox.html +++ b/docs/modules/Checkbox.html @@ -308,7 +308,7 @@
generated by LDoc 1.4.6 -Last updated 2020-10-12 00:29:49 +Last updated 2020-10-12 00:44:30
diff --git a/docs/modules/CheckboxGroup.html b/docs/modules/CheckboxGroup.html index 56349db..1b721fc 100644 --- a/docs/modules/CheckboxGroup.html +++ b/docs/modules/CheckboxGroup.html @@ -220,7 +220,7 @@
generated by LDoc 1.4.6 -Last updated 2020-10-12 00:29:49 +Last updated 2020-10-12 00:44:30
diff --git a/docs/modules/Drag.html b/docs/modules/Drag.html index 48b4c68..e37f4e8 100644 --- a/docs/modules/Drag.html +++ b/docs/modules/Drag.html @@ -464,7 +464,7 @@
generated by LDoc 1.4.6 -Last updated 2020-10-12 00:29:49 +Last updated 2020-10-12 00:44:30
diff --git a/docs/modules/DruidEvent.html b/docs/modules/DruidEvent.html index c5c7859..8f07b3c 100644 --- a/docs/modules/DruidEvent.html +++ b/docs/modules/DruidEvent.html @@ -262,7 +262,7 @@
generated by LDoc 1.4.6 -Last updated 2020-10-12 00:29:49 +Last updated 2020-10-12 00:44:30
diff --git a/docs/modules/DruidInstance.html b/docs/modules/DruidInstance.html index 2a79cd2..e697c3c 100644 --- a/docs/modules/DruidInstance.html +++ b/docs/modules/DruidInstance.html @@ -1103,7 +1103,7 @@
generated by LDoc 1.4.6 -Last updated 2020-10-12 00:29:49 +Last updated 2020-10-12 00:44:30
diff --git a/docs/modules/DynamicGrid.html b/docs/modules/DynamicGrid.html index 34e4ad6..513c24f 100644 --- a/docs/modules/DynamicGrid.html +++ b/docs/modules/DynamicGrid.html @@ -683,7 +683,7 @@
generated by LDoc 1.4.6 -Last updated 2020-10-12 00:29:49 +Last updated 2020-10-12 00:44:30
diff --git a/docs/modules/Hover.html b/docs/modules/Hover.html index 28dde66..0b1af90 100644 --- a/docs/modules/Hover.html +++ b/docs/modules/Hover.html @@ -305,7 +305,7 @@
generated by LDoc 1.4.6 -Last updated 2020-10-12 00:29:49 +Last updated 2020-10-12 00:44:30
diff --git a/docs/modules/Input.html b/docs/modules/Input.html index d5746c4..a257d7e 100644 --- a/docs/modules/Input.html +++ b/docs/modules/Input.html @@ -608,7 +608,7 @@
generated by LDoc 1.4.6 -Last updated 2020-10-12 00:29:49 +Last updated 2020-10-12 00:44:30
diff --git a/docs/modules/LangText.html b/docs/modules/LangText.html index c95f524..554aca9 100644 --- a/docs/modules/LangText.html +++ b/docs/modules/LangText.html @@ -218,7 +218,7 @@
generated by LDoc 1.4.6 -Last updated 2020-10-12 00:29:49 +Last updated 2020-10-12 00:44:30
diff --git a/docs/modules/Progress.html b/docs/modules/Progress.html index 1b4a333..ffe5e2d 100644 --- a/docs/modules/Progress.html +++ b/docs/modules/Progress.html @@ -497,7 +497,7 @@
generated by LDoc 1.4.6 -Last updated 2020-10-12 00:29:49 +Last updated 2020-10-12 00:44:30
diff --git a/docs/modules/RadioGroup.html b/docs/modules/RadioGroup.html index 5c3a04c..043430b 100644 --- a/docs/modules/RadioGroup.html +++ b/docs/modules/RadioGroup.html @@ -220,7 +220,7 @@
generated by LDoc 1.4.6 -Last updated 2020-10-12 00:29:49 +Last updated 2020-10-12 00:44:30
diff --git a/docs/modules/Scroll.html b/docs/modules/Scroll.html index b6932b3..845db2a 100644 --- a/docs/modules/Scroll.html +++ b/docs/modules/Scroll.html @@ -1008,7 +1008,7 @@
generated by LDoc 1.4.6 -Last updated 2020-10-12 00:29:49 +Last updated 2020-10-12 00:44:30
diff --git a/docs/modules/Slider.html b/docs/modules/Slider.html index 816d36f..c1c9995 100644 --- a/docs/modules/Slider.html +++ b/docs/modules/Slider.html @@ -396,7 +396,7 @@
generated by LDoc 1.4.6 -Last updated 2020-10-12 00:29:49 +Last updated 2020-10-12 00:44:30
diff --git a/docs/modules/StaticGrid.html b/docs/modules/StaticGrid.html index 8ad2dc5..186495e 100644 --- a/docs/modules/StaticGrid.html +++ b/docs/modules/StaticGrid.html @@ -732,7 +732,7 @@
generated by LDoc 1.4.6 -Last updated 2020-10-12 00:29:49 +Last updated 2020-10-12 00:44:30
diff --git a/docs/modules/Swipe.html b/docs/modules/Swipe.html index 20856a8..4957031 100644 --- a/docs/modules/Swipe.html +++ b/docs/modules/Swipe.html @@ -258,7 +258,7 @@
generated by LDoc 1.4.6 -Last updated 2020-10-12 00:29:49 +Last updated 2020-10-12 00:44:30
diff --git a/docs/modules/Text.html b/docs/modules/Text.html index 08d87b7..87fc999 100644 --- a/docs/modules/Text.html +++ b/docs/modules/Text.html @@ -586,7 +586,7 @@
generated by LDoc 1.4.6 -Last updated 2020-10-12 00:29:49 +Last updated 2020-10-12 00:44:30
diff --git a/docs/modules/Timer.html b/docs/modules/Timer.html index ae6fd75..39a50b4 100644 --- a/docs/modules/Timer.html +++ b/docs/modules/Timer.html @@ -378,7 +378,7 @@
generated by LDoc 1.4.6 -Last updated 2020-10-12 00:29:49 +Last updated 2020-10-12 00:44:30
diff --git a/docs/modules/druid.helper.html b/docs/modules/druid.helper.html index 5590dc8..f239731 100644 --- a/docs/modules/druid.helper.html +++ b/docs/modules/druid.helper.html @@ -312,7 +312,7 @@
generated by LDoc 1.4.6 -Last updated 2020-10-12 00:29:49 +Last updated 2020-10-12 00:44:30
diff --git a/docs/modules/druid.html b/docs/modules/druid.html index ec93bd4..ccca1a7 100644 --- a/docs/modules/druid.html +++ b/docs/modules/druid.html @@ -313,7 +313,7 @@
generated by LDoc 1.4.6 -Last updated 2020-10-12 00:29:49 +Last updated 2020-10-12 00:44:30
diff --git a/update_docs.sh b/update_docs.sh new file mode 100755 index 0000000..5aaf1e3 --- /dev/null +++ b/update_docs.sh @@ -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