Safe Haskell	None
Language	Haskell2010

GHC.Hs.Doc

Synopsis

data HsDocString
type LHsDocString = Located HsDocString
mkHsDocString :: String -> HsDocString
mkHsDocStringUtf8ByteString :: ByteString -> HsDocString
isEmptyDocString :: HsDocString -> Bool
unpackHDS :: HsDocString -> String
hsDocStringToByteString :: HsDocString -> ByteString
ppr_mbDoc :: Maybe LHsDocString -> SDoc
appendDocs :: HsDocString -> HsDocString -> HsDocString
concatDocs :: [HsDocString] -> Maybe HsDocString
newtype DeclDocMap = DeclDocMap (Map Name HsDocString)
emptyDeclDocMap :: DeclDocMap
newtype ArgDocMap = ArgDocMap (Map Name (IntMap HsDocString))
emptyArgDocMap :: ArgDocMap
data ExtractedTHDocs = ExtractedTHDocs {
- ethd_mod_header :: Maybe HsDocString
- ethd_decl_docs :: DeclDocMap
- ethd_arg_docs :: ArgDocMap
- ethd_inst_docs :: DeclDocMap
}

Documentation

data HsDocString Source #

Haskell Documentation String

Internally this is a UTF8-Encoded ByteString.

Instances

Instances details

Eq HsDocString Source #
Instance details Defined in GHC.Hs.Doc Methods (==) :: HsDocString -> HsDocString -> Bool # (/=) :: HsDocString -> HsDocString -> Bool #
Data HsDocString Source #
Instance details Defined in GHC.Hs.Doc Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> HsDocString -> c HsDocString # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c HsDocString # toConstr :: HsDocString -> Constr # dataTypeOf :: HsDocString -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c HsDocString) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c HsDocString) # gmapT :: (forall b. Data b => b -> b) -> HsDocString -> HsDocString # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> HsDocString -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> HsDocString -> r # gmapQ :: (forall d. Data d => d -> u) -> HsDocString -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> HsDocString -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> HsDocString -> m HsDocString # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> HsDocString -> m HsDocString # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> HsDocString -> m HsDocString #
Show HsDocString Source #
Instance details Defined in GHC.Hs.Doc Methods showsPrec :: Int -> HsDocString -> ShowS # show :: HsDocString -> String # showList :: [HsDocString] -> ShowS #
Outputable HsDocString Source #
Instance details Defined in GHC.Hs.Doc Methods ppr :: HsDocString -> SDoc Source #
Binary HsDocString Source #
Instance details Defined in GHC.Hs.Doc Methods put_ :: BinHandle -> HsDocString -> IO () Source # put :: BinHandle -> HsDocString -> IO (Bin HsDocString) Source # get :: BinHandle -> IO HsDocString Source #

type LHsDocString = Located HsDocString Source #

Located Haskell Documentation String

mkHsDocString :: String -> HsDocString Source #

mkHsDocStringUtf8ByteString :: ByteString -> HsDocString Source #

Create a HsDocString from a UTF8-encoded ByteString.

isEmptyDocString :: HsDocString -> Bool Source #

unpackHDS :: HsDocString -> String Source #

hsDocStringToByteString :: HsDocString -> ByteString Source #

Return the contents of a HsDocString as a UTF8-encoded ByteString.

ppr_mbDoc :: Maybe LHsDocString -> SDoc Source #

appendDocs :: HsDocString -> HsDocString -> HsDocString Source #

Join two docstrings.

Non-empty docstrings are joined with two newlines in between, resulting in separate paragraphs.

concatDocs :: [HsDocString] -> Maybe HsDocString Source #

Concat docstrings with two newlines in between.

Empty docstrings are skipped.

If all inputs are empty, Nothing is returned.

newtype DeclDocMap Source #

Docs for declarations: functions, data types, instances, methods etc.

Constructors

DeclDocMap (Map Name HsDocString)

Instances

Instances details

Outputable DeclDocMap Source #
Instance details Defined in GHC.Hs.Doc Methods ppr :: DeclDocMap -> SDoc Source #
Binary DeclDocMap Source #
Instance details Defined in GHC.Hs.Doc Methods put_ :: BinHandle -> DeclDocMap -> IO () Source # put :: BinHandle -> DeclDocMap -> IO (Bin DeclDocMap) Source # get :: BinHandle -> IO DeclDocMap Source #

emptyDeclDocMap :: DeclDocMap Source #

newtype ArgDocMap Source #

Docs for arguments. E.g. function arguments, method arguments.

Constructors

ArgDocMap (Map Name (IntMap HsDocString))

Instances

Instances details

Outputable ArgDocMap Source #
Instance details Defined in GHC.Hs.Doc Methods ppr :: ArgDocMap -> SDoc Source #
Binary ArgDocMap Source #
Instance details Defined in GHC.Hs.Doc Methods put_ :: BinHandle -> ArgDocMap -> IO () Source # put :: BinHandle -> ArgDocMap -> IO (Bin ArgDocMap) Source # get :: BinHandle -> IO ArgDocMap Source #

emptyArgDocMap :: ArgDocMap Source #

data ExtractedTHDocs Source #

Maps of docs that were added via Template Haskell's putDoc.

Constructors

ExtractedTHDocs
Fields ethd_mod_header :: Maybe HsDocString The added module header documentation, if it exists. ethd_decl_docs :: DeclDocMap The documentation added to declarations. ethd_arg_docs :: ArgDocMap The documentation added to function arguments. ethd_inst_docs :: DeclDocMap The documentation added to class and family instances.