1. Sergey Astanin
  2. hs-libzip

Commits

Sergey Astanin  committed c579843

haddock comments

  • Participants
  • Parent commits 1f55177
  • Branches 0.11-bindings-libzip

Comments (0)

Files changed (1)

File LibZip/Codec/Archive/LibZip.hs

View file
  • Ignore whitespace
 
 
 -- | Get the number of entries in the archive.
-numFiles :: [FileFlag] -> Archive Integer
+numFiles :: [FileFlag]  -- ^ 'FileUNCHANGED' can be used to return
+                        -- the original unchanged number of entries.
+         -> Archive Integer
 numFiles flags  = do
   z <- getZip
   lift $ fromIntegral `liftM` c'zip_get_num_entries z (combine flags)
        doIf' (r == 0) z $ toZipStat =<< peek stat
 
 -- | Delete file from the archive.
-deleteFile :: [FileFlag]  -- ^ Filename lookup mode.
+deleteFile :: [FileFlag]  -- ^ Filename lookup mode (see 'nameLocate').
            -> FilePath    -- ^ Filename.
            -> Archive ()
 deleteFile flags name = do
      else lift $ get_error z >>= E.throwIO
 
 -- | Rename file in the archive.
-renameFile :: [FileFlag]  -- ^ Filename lookup mode.
+renameFile :: [FileFlag]  -- ^ Filename lookup mode (see 'nameLocate').
            -> FilePath    -- ^ Old name.
            -> FilePath    -- ^ New name.
            -> Archive ()
      else return (fromIntegral r)
 
 -- | Replace a file in the archive.
-replaceFile :: [FileFlag]  -- ^ Filename lookup mode.
+replaceFile :: [FileFlag]  -- ^ Filename lookup mode (see 'nameLocate').
             -> FilePath    -- ^ File to replace.
             -> ZipSource   -- ^ Source where the new file data is obtained from.
             -> Archive ()
      else return ()
 
 -- | Remove comment for a file in the archive.
-removeFileComment :: [FileFlag]  -- ^ Filename lookup mode.
+removeFileComment :: [FileFlag]  -- ^ Filename lookup mode (see 'nameLocate').
                   -> FilePath    -- ^ Filename.
                   -> Archive ()
 removeFileComment flags path = do
      else return ()
 
 -- | Undo changes to a file in the archive.
-unchangeFile :: [FileFlag]  -- ^ Filename lookup mode.
+unchangeFile :: [FileFlag]  -- ^ Filename lookup mode (see 'nameLocate').
              -> FilePath    -- ^ Filename.
              -> Archive ()
 unchangeFile flags name = do