-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Generate HTML docs from a dhall package
--   
--   Use this package if you want to create HTML documentation from your
--   dhall packages:
--   
--   <ul>
--   <li>See the <a>Dhall.Docs</a> module if you want to use this package
--   as a library</li>
--   <li>Use the <tt>dhall-docs</tt> program from this package if you want
--   an executable</li>
--   </ul>
--   
--   The <a>Dhall.Docs</a> module also contains instructions for how to use
--   this package
@package dhall-docs
@version 1.0.4


-- | Contains all the functions that generate documentation
--   
--   We should always try to do as little work as possible in an <a>IO</a>
--   context. To do so, just wrap your function in <a>IO</a> if you need to
--   do I/O operations, and make pure functions receive that IO result as
--   an input
module Dhall.Docs.Core

-- | Generate all of the docs for a package. This function does all the `IO
--   ()` related tasks to call <a>generateDocsPure</a>
generateDocs :: Path Abs Dir -> Path Abs Dir -> Text -> CharacterSet -> IO ()

-- | Generates all the documentation of dhall package in a pure way i.e.
--   without an <a>IO</a> context. This let you generate documentation from
--   a list of dhall-files without saving them to the filesystem.
--   
--   If you want the <a>IO</a> version of this function, check
--   <a>generateDocs</a>
generateDocsPure :: Text -> CharacterSet -> [(Path Rel File, ByteString)] -> GeneratedDocs [(Path Rel File, Text)]

-- | The result of the doc-generator pure component
data GeneratedDocs a
GeneratedDocs :: [DocsGenWarning] -> a -> GeneratedDocs a

-- | Parse all comments in a text fragment
parseComments :: String -> Text -> [DhallComment 'RawComment]
data CommentParseError
MissingNewlineOnBlockComment :: CommentParseError
BadSingleLineCommentsAlignment :: CommentParseError
BadPrefixesOnSingleLineComments :: CommentParseError
SeveralSubseqDhallDocsComments :: CommentParseError

-- | Extracted text from a valid <tt>dhall-docs</tt> comment
data DhallDocsText

-- | Returns <a>Nothing</a> when <a>DhallDocsComment</a> was parsed or no
--   error was detected
parseSingleDhallDocsComment :: String -> Text -> Maybe (Either [CommentParseError] DhallDocsText)
unDhallDocsText :: DhallDocsText -> Text
instance GHC.Base.Functor Dhall.Docs.Core.GeneratedDocs
instance GHC.Base.Applicative Dhall.Docs.Core.GeneratedDocs
instance GHC.Base.Monad Dhall.Docs.Core.GeneratedDocs
instance Control.Monad.Writer.Class.MonadWriter [Dhall.Docs.Core.DocsGenWarning] Dhall.Docs.Core.GeneratedDocs
instance GHC.Show.Show Dhall.Docs.Core.DocsGenWarning


-- | This module contains the top level and options parsing of the
--   <tt>dhall-docs</tt> executable
module Dhall.Docs

-- | Command line options
data Options
Options :: FilePath -> FilePath -> (Path Abs Dir -> Text) -> CharacterSet -> Options

-- | Directory where your package resides
[packageDir] :: Options -> FilePath

-- | Link to the generated documentation
[docLink] :: Options -> FilePath
[resolvePackageName] :: Options -> Path Abs Dir -> Text
[characterSet] :: Options -> CharacterSet
Version :: Options

-- | <a>ParserInfo</a> for the <a>Options</a> type
parserInfoOptions :: ParserInfo Options

-- | <a>Parser</a> for the <a>Options</a> type
parseOptions :: Parser Options

-- | Entry point for the <tt>dhall-docs</tt> executable
main :: IO ()

-- | Default execution of <tt>dhall-docs</tt> command
defaultMain :: Options -> IO ()