From aa44d6c0da442887155a47c77f03209224517af0 Mon Sep 17 00:00:00 2001 From: Jasper Van der Jeugt Date: Sun, 17 Jan 2010 12:37:55 +0100 Subject: Documentation++. --- src/Text/Hakyll/File.hs | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) (limited to 'src/Text/Hakyll/File.hs') diff --git a/src/Text/Hakyll/File.hs b/src/Text/Hakyll/File.hs index ed2bbea..0a21638 100644 --- a/src/Text/Hakyll/File.hs +++ b/src/Text/Hakyll/File.hs @@ -31,11 +31,11 @@ removeLeadingSeparator path path' = if "$root" `isPrefixOf` path then drop 5 path else path --- | Convert a relative filepath to a filepath in the destination (_site). +-- | Convert a relative filepath to a filepath in the destination (@_site@). toDestination :: FilePath -> FilePath toDestination path = "_site" (removeLeadingSeparator path) --- | Convert a relative filepath to a filepath in the cache (_cache). +-- | Convert a relative filepath to a filepath in the cache (@_cache@). toCache :: FilePath -> FilePath toCache path = "_cache" (removeLeadingSeparator path) @@ -100,7 +100,9 @@ directory action dir = do mapM_ action contents -- | Check if a cache file is still valid. -isCacheValid :: FilePath -> [FilePath] -> Hakyll Bool +isCacheValid :: FilePath -- ^ The cached file. + -> [FilePath] -- ^ Dependencies of the cached file. + -> Hakyll Bool isCacheValid cache depends = do exists <- liftIO $ doesFileExist cache if not exists -- cgit v1.2.3