Move docs to luacs-docs/{lua,cs,landing-page}
luacs-docs/cs also has a proper http server for testing locally
This commit is contained in:
43
luacs-docs/lua/lua/File.lua
Normal file
43
luacs-docs/lua/lua/File.lua
Normal file
@@ -0,0 +1,43 @@
|
||||
-- luacheck: ignore 111
|
||||
|
||||
--[[--
|
||||
Class providing filesystem functionality.
|
||||
]]
|
||||
-- @code File
|
||||
-- @pragma nostrip
|
||||
|
||||
File = {}
|
||||
|
||||
--- Read contents from path
|
||||
-- @treturn string file contents
|
||||
-- @realm shared
|
||||
function File.Read(path) end
|
||||
|
||||
--- Write text to file
|
||||
-- @realm shared
|
||||
function File.Write(path, text) end
|
||||
|
||||
--- Check if file exists.
|
||||
-- @treturn bool
|
||||
-- @realm shared
|
||||
function File.Exists(path) end
|
||||
|
||||
--- Check if directory exists.
|
||||
-- @treturn bool
|
||||
-- @realm shared
|
||||
function File.DirectoryExists(path) end
|
||||
|
||||
--- Check if directory exists.
|
||||
-- @treturn table table containing all files
|
||||
-- @realm shared
|
||||
function File.GetFiles(path) end
|
||||
|
||||
--- List all directories.
|
||||
-- @treturn table table containing all directories
|
||||
-- @realm shared
|
||||
function File.GetDirectories(path) end
|
||||
|
||||
--- Search directory for all files including sub directories.
|
||||
-- @treturn table table containing all files
|
||||
-- @realm shared
|
||||
function File.DirSearch(path) end
|
||||
Reference in New Issue
Block a user