mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-11-06 01:56:21 +00:00
Code Issues Releases Wiki Activity
298f339376
CC-Tweaked/doc/stub/fs.lua

37 lines
1.5 KiB
Lua
Raw Normal View History

An initial stab at documentation generation (#360) This adds documentation comments to many of CC's Lua APIs, and a couple of the Java ones, through the use of stubs. We then export these to HTML using illuaminate [1] and upload them to our documentation site [2]. Uploads currently occur on pushes to master and any release/tag. The site is entirely static - there is no way to switch between versions, etc... but hopefully we can improve this in the future. [1]: github.com/SquidDev/illuaminate/ [2]: https://tweaked.cc/
2020-04-10 09:27:53 +00:00
--- The FS API allows you to manipulate files and the filesystem.
--
-- @module fs
Improvements to the various file system programs (rm, mv, rename) (#440) This enforces several sanity checks before actually attempting the move, allowing us to produce friendlier error messages.
2020-05-12 10:32:48 +00:00
--- Returns true if a path is mounted to the parent filesystem.
--
-- The root filesystem "/" is considered a mount, along with disk folders and
-- the rom folder. Other programs (such as network shares) can exstend this to
-- make other mount types by correctly assigning their return value for getDrive.
--
-- @tparam string path The path to check.
-- @treturn boolean If the path is mounted, rather than a normal file/folder.
-- @throws If the path does not exist.
-- @see getDrive
Add the rest of the feature introduction versions to the docs (#908)
2021-08-26 07:02:58 +00:00
-- @since 1.87.0
Improvements to the various file system programs (rm, mv, rename) (#440) This enforces several sanity checks before actually attempting the move, allowing us to produce friendlier error messages.
2020-05-12 10:32:48 +00:00
function isDriveRoot(path) end
Add a whole tonne of documentation There's a bit of duplication here, so we might try to clean this up, but it's a good starting point.
2020-07-09 20:59:19 +00:00
--[[- Provides completion for a file or directory name, suitable for use with
Clean up some examples a little bit Would be good if they didn't crash and burn on entry :).
2020-11-12 19:40:18 +00:00
@{_G.read}.
Fix usages of global variables - Lint references to unknown fields of modules, excluding the keys and colours modules. This caught several silly errors in our stub files, but nothing else. - Lint on using unknown globals. This highlighted a couple of really silly mistakes. Fixes #427. - Add documentation for fs.attributes, fs.getCapacity and pocket, as they were not defined before. Co-authored-by: JackMacWindows <jackmacwindowslinux@gmail.com>
2020-04-28 08:42:34 +00:00
Add a whole tonne of documentation There's a bit of duplication here, so we might try to clean this up, but it's a good starting point.
2020-07-09 20:59:19 +00:00
When a directory is a possible candidate for completion, two entries are
included - one with a trailing slash (indicating that entries within this
directory exist) and one without it (meaning this entry is an immediate
completion candidate). `include_dirs` can be set to @{false} to only include
those with a trailing slash.
An initial stab at documentation generation (#360) This adds documentation comments to many of CC's Lua APIs, and a couple of the Java ones, through the use of stubs. We then export these to HTML using illuaminate [1] and upload them to our documentation site [2]. Uploads currently occur on pushes to master and any release/tag. The site is entirely static - there is no way to switch between versions, etc... but hopefully we can improve this in the future. [1]: github.com/SquidDev/illuaminate/ [2]: https://tweaked.cc/
2020-04-10 09:27:53 +00:00
Add a whole tonne of documentation There's a bit of duplication here, so we might try to clean this up, but it's a good starting point.
2020-07-09 20:59:19 +00:00
@tparam string path The path to complete.
@tparam string location The location where paths are resolved from.
@tparam[opt] boolean include_files When @{false}, only directories will be
included in the returned list.
@tparam[opt] boolean include_dirs When @{false}, "raw" directories will not be
included in the returned list.
@treturn { string... } A list of possible completion candidates.
Add the rest of the feature introduction versions to the docs (#908)
2021-08-26 07:02:58 +00:00
@since 1.74
Add a whole tonne of documentation There's a bit of duplication here, so we might try to clean this up, but it's a good starting point.
2020-07-09 20:59:19 +00:00
]]
function complete(path, location, include_files, include_dirs) end
Reference in New Issue Copy Permalink