diff --git a/.gitignore b/.gitignore index 6985cf1..08b32d6 100644 --- a/.gitignore +++ b/.gitignore @@ -12,3 +12,5 @@ Cargo.lock # MSVC Windows builds of rustc generate these, which store debugging information *.pdb + +api/lua/doc/doc diff --git a/api/lua/doc/output.lua b/api/lua/doc/output.lua index 4b08e6e..44afe99 100644 --- a/api/lua/doc/output.lua +++ b/api/lua/doc/output.lua @@ -121,7 +121,6 @@ function output_module.tags(op) end ---Add tags to the specified output. ---@tparam Output op ---@tparam string ... The names of the tags you want to add. You can also pass in a table. ----@overload fun(op: Output, tag_names: string[]) ---@see TagModule.add ---@see Output.add_tags function output_module.add_tags(op, ...) end @@ -143,7 +142,6 @@ function output:tags() end ---Add tags to this output. ---@tparam string ... The names of the tags you want to add. You can also pass in a table. ----@overload fun(self: self, tag_names: string[]) ---@see OutputModule.add_tags function output:add_tags(...) end diff --git a/api/lua/doc/tag.lua b/api/lua/doc/tag.lua index c9d5533..0bd1239 100644 --- a/api/lua/doc/tag.lua +++ b/api/lua/doc/tag.lua @@ -29,7 +29,6 @@ local tag_module = {} --- tag.add(op, tags) -- Add tags with those names ---@tparam Output output The output you want these tags to be added to. ---@tparam string ... The names of the new tags you want to add. ----@overload fun(output: Output, tag_names: string[]) ---@see Output.add_tags function tag_module.add(output, ...) end @@ -43,7 +42,6 @@ function tag_module.add(output, ...) end --- -- will cause windows on both tags 1 and 2 to be displayed at the same time. ---@tparam string name The name of the tag. ---@tparam ?Output output The output. ----@overload fun(t: Tag) ---@see Tag.toggle function tag_module.toggle(name, output) end @@ -58,7 +56,6 @@ function tag_module.toggle(name, output) end --- tag.switch_to("3") ---@tparam string name The name of the tag. ---@tparam ?Output output The output. ----@overload fun(t: Tag) ---@see Tag.switch_to function tag_module.switch_to(name, output) end @@ -75,7 +72,6 @@ function tag_module.switch_to(name, output) end ---@tparam string name The name of the tag. ---@tparam Layout layout The layout. ---@tparam ?Output output The output. ----@overload fun(t: Tag, layout: Layout) ---@see Tag.set_layout function tag_module.set_layout(name, layout, output) end diff --git a/api/lua/doc/window.lua b/api/lua/doc/window.lua index 59dacb6..9f43427 100644 --- a/api/lua/doc/window.lua +++ b/api/lua/doc/window.lua @@ -31,7 +31,6 @@ function window_module.get_all() end ---@tparam Window w ---@tparam string name ---@tparam ?Output output ----@overload fun(w: Window, t: Tag) ----- ---@see Window.toggle_tag function window_module.toggle_tag(w, name, output) end @@ -40,7 +39,6 @@ function window_module.toggle_tag(w, name, output) end ---@tparam Window w ---@tparam string name ---@tparam ?Output output ----@overload fun(w: Window, t: Tag) --- ---@see Window.move_to_tag function window_module.move_to_tag(w, name, output) end @@ -182,7 +180,6 @@ function window:set_size(size) end --- -- ...will make the window only appear on tag 5. ---@tparam string name ---@tparam ?Output output ----@overload fun(self: self, t: Tag) --- ---@see WindowModule.move_to_tag function window:move_to_tag(name, output) end @@ -196,7 +193,6 @@ function window:move_to_tag(name, output) end --- -- ...will also make the window appear on tag 2. ---@tparam string name ---@tparam ?Output output ----@overload fun(self: self, t: Tag) --- ---@see WindowModule.toggle_tag function window:toggle_tag(name, output) end