mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-07-08 04:44:27 +00:00
9f8774960f
illuaminate does not handle Java files, for obvious reasons. In order to get around that, we have a series of stub files within /doc/stub which mirrored the Java ones. While this works, it has a few problems: - The link to source code does not work - it just links to the stub file. - There's no guarantee that documentation remains consistent with the Java code. This change found several methods which were incorrectly documented beforehand. We now replace this with a custom Java doclet[1], which extracts doc comments from @LuaFunction annotated methods and generates stub-files from them. These also contain a @source annotation, which allows us to correctly link them back to the original Java code. There's some issues with this which have yet to be fixed. However, I don't think any of them are major blockers right now: - The custom doclet relies on Java 9 - I think it's /technically/ possible to do this on Java 8, but the API is significantly uglier. This means that we need to run javadoc on a separate JVM. This is possible, and it works locally and on CI, but is definitely not a nice approach. - illuaminate now requires the doc stubs to be generated in order for the linter to pass, which does make running the linter locally much harder (especially given the above bullet point). We could notionally include the generated stubs (or at least a cut down version of them) in the repo, but I'm not 100% sure about that. [1]: https://docs.oracle.com/javase/9/docs/api/jdk/javadoc/doclet/package-summary.html
41 lines
1.3 KiB
Lua
41 lines
1.3 KiB
Lua
--- The FS API allows you to manipulate files and the filesystem.
|
|
--
|
|
-- @module fs
|
|
|
|
--- 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
|
|
function isDriveRoot(path) end
|
|
|
|
-- Defined in bios.lua
|
|
function complete(sPath, sLocation, bIncludeFiles, bIncludeDirs) end
|
|
|
|
--- A file handle which can be read from.
|
|
--
|
|
-- @type ReadHandle
|
|
-- @see fs.open
|
|
local ReadHandle = {}
|
|
function ReadHandle.read(count) end
|
|
function ReadHandle.readAll() end
|
|
function ReadHandle.readLine(with_trailing) end
|
|
function ReadHandle.seek(whence, offset) end
|
|
function ReadHandle.close() end
|
|
|
|
--- A file handle which can be written to.
|
|
--
|
|
-- @type WriteHandle
|
|
-- @see fs.open
|
|
local WriteHandle = {}
|
|
function WriteHandle.write(text) end
|
|
function WriteHandle.writeLine(text) end
|
|
function WriteHandle.flush(text) end
|
|
function WriteHandle.seek(whence, offset) end
|
|
function WriteHandle.close() end
|