Make function comments psc-doc friendly

Author: felixSchl

src/Node/FS/Aff.purs

@@ -39,180 +39,180 @@ import qualified Node.FS.Async as A
 toAff :: forall eff a.
   (A.Callback eff a -> Eff (fs :: F.FS | eff) Unit) ->
   Aff (fs :: F.FS | eff) a
-toAff p = makeAff (\e a -> p $ either e a)
+toAff p = makeAff \e a -> p $ either e a
 
 toAff1 f a     = toAff (f a)
 toAff2 f a b   = toAff (f a b)
 toAff3 f a b c = toAff (f a b c)
 
 -- |
--- Renames a file.
---
+-- | Rename a file.
+-- |
 rename :: forall eff. FilePath
                    -> FilePath
                    -> Aff (fs :: F.FS | eff) Unit
 rename = toAff2 A.rename
 
 -- |
--- Truncates a file to the specified length.
---
+-- | Truncates a file to the specified length.
+-- |
 truncate :: forall eff. FilePath
                      -> Number
                      -> Aff (fs :: F.FS | eff) Unit
 truncate = toAff2 A.truncate
 
 -- |
--- Changes the ownership of a file.
---
+-- | Changes the ownership of a file.
+-- |
 chown :: forall eff. FilePath
                   -> Number
                   -> Number
                   -> Aff (fs :: F.FS | eff) Unit
 chown = toAff3 A.chown
 
 -- |
--- Changes the permissions of a file.
---
+-- | Changes the permissions of a file.
+-- |
 chmod :: forall eff. FilePath
                   -> Perms
                   -> Aff (fs :: F.FS | eff) Unit
 chmod = toAff2 A.chmod
 
 -- |
--- Gets file statistics.
---
+-- | Gets file statistics.
+-- |
 stat :: forall eff. FilePath
                  -> Aff (fs :: F.FS | eff) Stats
 stat = toAff1 A.stat
 
 -- |
--- Creates a link to an existing file.
---
+-- | Creates a link to an existing file.
+-- |
 link :: forall eff. FilePath
                  -> FilePath
                  -> Aff (fs :: F.FS | eff) Unit
 link = toAff2 A.link
 
 -- |
--- Creates a symlink.
---
+-- | Creates a symlink.
+-- |
 symlink :: forall eff. FilePath
                     -> FilePath
                     -> F.SymlinkType
                     -> Aff (fs :: F.FS | eff) Unit
 symlink = toAff3 A.symlink
 
 -- |
--- Reads the value of a symlink.
---
+-- | Reads the value of a symlink.
+-- |
 readlink :: forall eff. FilePath
                      -> Aff (fs :: F.FS | eff) FilePath
 readlink = toAff1 A.readlink
 
 -- |
--- Find the canonicalized absolute location for a path.
---
+-- | Find the canonicalized absolute location for a path.
+-- |
 realpath :: forall eff. FilePath
                      -> Aff (fs :: F.FS | eff) FilePath
 realpath = toAff1 A.realpath
 
 -- |
--- Find the canonicalized absolute location for a path using a cache object for
--- already resolved paths.
---
+-- | Find the canonicalized absolute location for a path using a cache object
+-- | for already resolved paths.
+-- |
 realpath' :: forall eff cache. FilePath
                             -> { | cache }
                             -> Aff (fs :: F.FS | eff) FilePath
 realpath' = toAff2 A.realpath'
 
 -- |
--- Deletes a file.
---
+-- | Deletes a file.
+-- |
 unlink :: forall eff. FilePath
                    -> Aff (fs :: F.FS | eff) Unit
 unlink = toAff1 A.unlink
 
 -- |
--- Deletes a directory.
---
+-- | Deletes a directory.
+-- |
 rmdir :: forall eff. FilePath
                    -> Aff (fs :: F.FS | eff) Unit
 rmdir = toAff1 A.rmdir
 
 -- |
--- Makes a new directory.
---
+-- | Makes a new directory.
+-- |
 mkdir :: forall eff. FilePath
                   -> Aff (fs :: F.FS | eff) Unit
 mkdir = toAff1 A.mkdir
 
 -- |
--- Makes a new directory with the specified permissions.
---
+-- | Makes a new directory with the specified permissions.
+-- |
 mkdir' :: forall eff. FilePath
                    -> Perms
                    -> Aff (fs :: F.FS | eff) Unit
 mkdir' = toAff2 A.mkdir'
 
 -- |
--- Reads the contents of a directory.
---
+-- | Reads the contents of a directory.
+-- |
 readdir :: forall eff. FilePath
                     -> Aff (fs :: F.FS | eff) [FilePath]
 readdir = toAff1 A.readdir
 
---|
--- Sets the accessed and modified times for the specified file.
---
+-- |
+-- | Sets the accessed and modified times for the specified file.
+-- |
 utimes :: forall eff. FilePath
                    -> Date
                    -> Date
                    -> Aff (fs :: F.FS | eff) Unit
 utimes = toAff3 A.utimes
 
 -- |
--- Reads the entire contents of a file returning the result as a raw buffer.
---
+-- | Reads the entire contents of a file returning the result as a raw buffer.
+-- |
 readFile :: forall eff. FilePath
                      -> Aff (fs :: F.FS | eff) Buffer
 readFile = toAff1 A.readFile
 
 -- |
--- Reads the entire contents of a text file with the specified encoding.
---
+-- | Reads the entire contents of a text file with the specified encoding.
+-- |
 readTextFile :: forall eff. Encoding
                          -> FilePath
                          -> Aff (fs :: F.FS | eff) String
 readTextFile = toAff2 A.readTextFile
 
 -- |
--- Writes a buffer to a file.
---
+-- | Writes a buffer to a file.
+-- |
 writeFile :: forall eff. FilePath
                       -> Buffer
                       -> Aff (fs :: F.FS | eff) Unit
 writeFile = toAff2 A.writeFile
 
 -- |
--- Writes text to a file using the specified encoding.
---
+-- | Writes text to a file using the specified encoding.
+-- |
 writeTextFile :: forall eff. Encoding
                           -> FilePath
                           -> String
                           -> Aff (fs :: F.FS | eff) Unit
 writeTextFile = toAff3 A.writeTextFile
 
 -- |
--- Appends the contents of a buffer to a file.
---
+-- | Appends the contents of a buffer to a file.
+-- |
 appendFile :: forall eff. FilePath
                        -> Buffer
                        -> Aff (fs :: F.FS | eff) Unit
 appendFile = toAff2 A.appendFile
 
 -- |
--- Appends text to a file using the specified encoding.
---
+-- | Appends text to a file using the specified encoding.
+-- |
 appendTextFile :: forall eff. Encoding
                            -> FilePath
                            -> String
@@ -226,6 +226,9 @@ import Data.Function
 foreign import fs "var fs = require('fs');" ::
   { exists :: forall a. Fn2 FilePath (Boolean -> a) Unit }
 
+-- |
+-- | Check to see if a file exists.
+-- |
 exists :: forall eff. String
                    -> Aff (fs :: F.FS | eff) Boolean
 exists file = makeAff \_ a -> pure $ runFn2 fs.exists file a