Add better documentation to functions for editors

lib/compression.luau

@@ -8,9 +8,28 @@ type CompressionModule = {
 local compressionModule = {} :: CompressionModule
 
 
--- take in file contents and zlib decompress them
--- if recursive param is true repeatedly zlib decompress the file until it fails
--- (modelscrape files are often double/triple zlib decompressed)
+--[[
+    Decompresses zlib-compressed data. If recursive is true, continues to decompress until data is no longer zlib-compressed.
+
+    ### Example usage
+
+    ```lua
+    local fs = require("@lune/fs")
+    local compression = require("./compression")
+
+    local compressedData = fs.readFile("compressedFile.bin")
+    local decompressedData = compression.zlibDecompress(compressedData, true)
+    if decompressedData then
+        print("Decompression successful.")
+    else
+        print("Decompression failed.")
+    end
+    ```
+
+    @param contents The zlib-compressed data as a string.
+    @param opts Options table of type `types.opts`
+    @return The decompressed data as a string, or false if decompression fails.
+]]--
 function compressionModule.zlibDecompress(contents: string,  opts: types.opts): string | boolean
     assert(typeof(contents) == "string", "Expected contents to be of type 'string'")
     assert(typeof(opts) == "table", "Expected opts to be of type 'table'")