new documentation and some fixes in code

This commit is contained in:
Evil Factory
2021-09-12 15:58:59 -03:00
parent 3cd5a23af7
commit 656af7df2f
29 changed files with 1861 additions and 5 deletions

40
docs/lua/File.lua Normal file
View File

@@ -0,0 +1,40 @@
-- luacheck: ignore 111
--[[--
Class providing filesystem functionality.
]]
-- @code File
--- Read contents from path
-- @treturn string file contents
-- @realm shared
function Read(path) end
--- Write text to file
-- @realm shared
function Write(path, text) end
--- Check if file exists.
-- @treturn bool
-- @realm shared
function Exists(path) end
--- Check if directory exists.
-- @treturn bool
-- @realm shared
function DirectoryExists(path) end
--- Check if directory exists.
-- @treturn table table containing all files
-- @realm shared
function GetFiles(path) end
--- List all directories.
-- @treturn table table containing all directories
-- @realm shared
function GetDirectories(path) end
--- Search directory for all files including sub directories.
-- @treturn table table containing all files
-- @realm shared
function DirSearch(path) end