added docs

Tranberry · Feb 25, 2024 · 956e793 · 956e793
1 parent bdd9efe
commit 956e793
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/lib/write_file.dart b/lib/write_file.dart
@@ -1,5 +1,9 @@
 import 'dart:io';
 
+/// Writes the given payload to the file at the specified path.
+///
+/// * [path]: The path to the file.
+/// * [payload]: The content to be written to the file.
 void writeFile(String path, String payload) {
   File file = File(path);
   file.writeAsStringSync(payload);