ghc-lib-parser-0.20191201: The GHC API, decoupled from GHC versions

Safe HaskellNone
LanguageHaskell2010

GHC.Hs.Doc

Synopsis

Documentation

data HsDocString Source #

Haskell Documentation String

Internally this is a UTF8-Encoded ByteString.

Instances
Eq HsDocString Source # 
Instance details

Defined in GHC.Hs.Doc

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 :: (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

Outputable HsDocString Source # 
Instance details

Defined in GHC.Hs.Doc

Binary HsDocString Source # 
Instance details

Defined in GHC.Hs.Doc

type LHsDocString = Located HsDocString Source #

Located Haskell Documentation String

hsDocStringToByteString :: HsDocString -> ByteString Source #

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

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
Outputable DeclDocMap Source # 
Instance details

Defined in GHC.Hs.Doc

Binary DeclDocMap Source # 
Instance details

Defined in GHC.Hs.Doc

newtype ArgDocMap Source #

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

Constructors

ArgDocMap (Map Name (Map Int HsDocString)) 
Instances
Outputable ArgDocMap Source # 
Instance details

Defined in GHC.Hs.Doc

Binary ArgDocMap Source # 
Instance details

Defined in GHC.Hs.Doc