@@ -31,10 +31,10 @@ class Filesystem
3131 * If the target file is newer, it is overwritten only when the
3232 * $overwriteNewerFiles option is set to true.
3333 *
34+ * @return void
35+ *
3436 * @throws FileNotFoundException When originFile doesn't exist
3537 * @throws IOException When copy fails
36- *
37- * @return void
3838 */
3939 public function copy (string $ originFile , string $ targetFile , bool $ overwriteNewerFiles = false )
4040 {
@@ -84,9 +84,9 @@ public function copy(string $originFile, string $targetFile, bool $overwriteNewe
8484 /**
8585 * Creates a directory recursively.
8686 *
87- * @throws IOException On any directory creation failure
88- *
8987 * @return void
88+ *
89+ * @throws IOException On any directory creation failure
9090 */
9191 public function mkdir (string |iterable $ dirs , int $ mode = 0777 )
9292 {
@@ -127,9 +127,9 @@ public function exists(string|iterable $files): bool
127127 * @param int|null $time The touch time as a Unix timestamp, if not supplied the current system time is used
128128 * @param int|null $atime The access time as a Unix timestamp, if not supplied the current system time is used
129129 *
130- * @throws IOException When touch fails
131- *
132130 * @return void
131+ *
132+ * @throws IOException When touch fails
133133 */
134134 public function touch (string |iterable $ files , int $ time = null , int $ atime = null )
135135 {
@@ -143,9 +143,9 @@ public function touch(string|iterable $files, int $time = null, int $atime = nul
143143 /**
144144 * Removes files or directories.
145145 *
146- * @throws IOException When removal fails
147- *
148146 * @return void
147+ *
148+ * @throws IOException When removal fails
149149 */
150150 public function remove (string |iterable $ files )
151151 {
@@ -211,9 +211,9 @@ private static function doRemove(array $files, bool $isRecursive): void
211211 * @param int $umask The mode mask (octal)
212212 * @param bool $recursive Whether change the mod recursively or not
213213 *
214- * @throws IOException When the change fails
215- *
216214 * @return void
215+ *
216+ * @throws IOException When the change fails
217217 */
218218 public function chmod (string |iterable $ files , int $ mode , int $ umask = 0000 , bool $ recursive = false )
219219 {
@@ -233,9 +233,9 @@ public function chmod(string|iterable $files, int $mode, int $umask = 0000, bool
233233 * @param string|int $user A user name or number
234234 * @param bool $recursive Whether change the owner recursively or not
235235 *
236- * @throws IOException When the change fails
237- *
238236 * @return void
237+ *
238+ * @throws IOException When the change fails
239239 */
240240 public function chown (string |iterable $ files , string |int $ user , bool $ recursive = false )
241241 {
@@ -261,9 +261,9 @@ public function chown(string|iterable $files, string|int $user, bool $recursive
261261 * @param string|int $group A group name or number
262262 * @param bool $recursive Whether change the group recursively or not
263263 *
264- * @throws IOException When the change fails
265- *
266264 * @return void
265+ *
266+ * @throws IOException When the change fails
267267 */
268268 public function chgrp (string |iterable $ files , string |int $ group , bool $ recursive = false )
269269 {
@@ -286,10 +286,10 @@ public function chgrp(string|iterable $files, string|int $group, bool $recursive
286286 /**
287287 * Renames a file or a directory.
288288 *
289+ * @return void
290+ *
289291 * @throws IOException When target file or directory already exists
290292 * @throws IOException When origin cannot be renamed
291- *
292- * @return void
293293 */
294294 public function rename (string $ origin , string $ target , bool $ overwrite = false )
295295 {
@@ -329,9 +329,9 @@ private function isReadable(string $filename): bool
329329 /**
330330 * Creates a symbolic link or copy a directory.
331331 *
332- * @throws IOException When symlink fails
333- *
334332 * @return void
333+ *
334+ * @throws IOException When symlink fails
335335 */
336336 public function symlink (string $ originDir , string $ targetDir , bool $ copyOnWindows = false )
337337 {
@@ -367,10 +367,10 @@ public function symlink(string $originDir, string $targetDir, bool $copyOnWindow
367367 *
368368 * @param string|string[] $targetFiles The target file(s)
369369 *
370+ * @return void
371+ *
370372 * @throws FileNotFoundException When original file is missing or not a file
371373 * @throws IOException When link fails, including if link already exists
372- *
373- * @return void
374374 */
375375 public function hardlink (string $ originFile , string |iterable $ targetFiles )
376376 {
@@ -526,9 +526,9 @@ public function makePathRelative(string $endPath, string $startPath): string
526526 * - $options['copy_on_windows'] Whether to copy files instead of links on Windows (see symlink(), defaults to false)
527527 * - $options['delete'] Whether to delete files that are not in the source directory (defaults to false)
528528 *
529- * @throws IOException When file type is unknown
530- *
531529 * @return void
530+ *
531+ * @throws IOException When file type is unknown
532532 */
533533 public function mirror (string $ originDir , string $ targetDir , \Traversable $ iterator = null , array $ options = [])
534534 {
@@ -652,9 +652,9 @@ public function tempnam(string $dir, string $prefix, string $suffix = ''): strin
652652 *
653653 * @param string|resource $content The data to write into the file
654654 *
655- * @throws IOException if the file cannot be written to
656- *
657655 * @return void
656+ *
657+ * @throws IOException if the file cannot be written to
658658 */
659659 public function dumpFile (string $ filename , $ content )
660660 {
@@ -693,9 +693,9 @@ public function dumpFile(string $filename, $content)
693693 * @param string|resource $content The content to append
694694 * @param bool $lock Whether the file should be locked when writing to it
695695 *
696- * @throws IOException If the file is not writable
697- *
698696 * @return void
697+ *
698+ * @throws IOException If the file is not writable
699699 */
700700 public function appendToFile (string $ filename , $ content/* , bool $lock = false */ )
701701 {
0 commit comments