From 3a7bd26067872d55b69e67f67bde935392cdd04b Mon Sep 17 00:00:00 2001 From: Celtic Minstrel Date: Mon, 6 Feb 2023 20:52:18 -0500 Subject: [PATCH] [LuaDoc] Document ndirs member of a directory listing --- utils/emmylua/filesystem.lua | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/utils/emmylua/filesystem.lua b/utils/emmylua/filesystem.lua index 42a5ec7fd99..22c483ffbe0 100644 --- a/utils/emmylua/filesystem.lua +++ b/utils/emmylua/filesystem.lua @@ -2,12 +2,15 @@ filesystem = {} +---@class directory_listing : string[] +---@field ndirs integer + ---Read a text file into memory, or list files in a directory ---@param path string ----@return string|string[] +---@return string|directory_listing function filesystem.read_file(path) end ----Check if a file exists +---Check if a file exists and whether ---@param path string ---@param real_file? boolean If true, the file must be a real file and not for example a directory. ---@return boolean