hasufell/hsfm
1
1
Fork 0
Code Issues 33 Pull Requests Releases Wiki Activity

LIB: fix documentation in IO.File

Browse Source
This commit is contained in:
Julian Ospald 2015-12-23 16:10:08 +01:00
parent f55572542f
commit 1aeb92d657
No known key found for this signature in database
GPG Key ID: 220CD1C5BDEED020
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/IO/File.hs
View File

@ -127,7 +127,7 @@ runFileOp _ = return Nothing
-- TODO: allow renaming -- TODO: allow renaming
-- |Copies a directory to the given destination with the specified -- |Copies a directory to the given destination with the specified
-- `DirCopyMode`. -- `DirCopyMode`. Excludes symlinks.
copyDir :: DirCopyMode copyDir :: DirCopyMode
-> AnchoredFile FileInfo FileInfo -- ^ source dir -> AnchoredFile FileInfo FileInfo -- ^ source dir
-> AnchoredFile FileInfo FileInfo -- ^ destination dir -> AnchoredFile FileInfo FileInfo -- ^ destination dir
@ -191,7 +191,8 @@ recreateSymlink symf@(IsSymL True)
recreateSymlink _ _ = return () recreateSymlink _ _ = return ()
-- |Copies the given file to the given file destination. Not symlinks. -- |Copies the given file to the given file destination.
-- Excludes symlinks.
copyFile :: AnchoredFile FileInfo FileInfo -- ^ source file copyFile :: AnchoredFile FileInfo FileInfo -- ^ source file
-> AnchoredFile FileInfo FileInfo -- ^ destination file -> AnchoredFile FileInfo FileInfo -- ^ destination file
-> IO () -> IO ()
@ -205,7 +206,7 @@ copyFile _ _ = return ()
-- |Copies the given file to the given dir with the same filename. -- |Copies the given file to the given dir with the same filename.
-- This can also be called on symlinks. -- Excludes symlinks.
copyFileToDir :: AnchoredFile FileInfo FileInfo copyFileToDir :: AnchoredFile FileInfo FileInfo
-> AnchoredFile FileInfo FileInfo -> AnchoredFile FileInfo FileInfo
-> IO () -> IO ()
@ -219,6 +220,8 @@ copyFileToDir from@(_ :/ RegFile fn _)
copyFileToDir _ _ = return () copyFileToDir _ _ = return ()
-- |Copies a file, directory or symlink. In case of a symlink, it is just
-- recreated, even if it points to a directory.
easyCopy :: DirCopyMode easyCopy :: DirCopyMode
-> AnchoredFile FileInfo FileInfo -> AnchoredFile FileInfo FileInfo
-> AnchoredFile FileInfo FileInfo -> AnchoredFile FileInfo FileInfo
@ -322,7 +325,8 @@ deleteDirRecursive _ = return ()
-- |Deletes a file, directory or symlink, whatever it may be. -- |Deletes a file, directory or symlink, whatever it may be.
-- In case of directory, performs recursive deletion. -- In case of directory, performs recursive deletion. In case of
-- a symlink, the symlink file is deleted.
easyDelete :: AnchoredFile FileInfo FileInfo -> IO () easyDelete :: AnchoredFile FileInfo FileInfo -> IO ()
easyDelete f@(IsSymL True) = deleteSymlink f easyDelete f@(IsSymL True) = deleteSymlink f
easyDelete f@(_ :/ RegFile {}) easyDelete f@(_ :/ RegFile {})