HsDoc

Documentation

data HsDocString

Haskell Documentation String

Internally this is a UTF8-Encoded ByteString.

Instances

Eq HsDocString

Defined in HsDoc

Methods

(==) :: HsDocString -> HsDocString -> Bool

(/=) :: HsDocString -> HsDocString -> Bool

Data HsDocString

Defined in HsDoc

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

Defined in HsDoc

Methods

showsPrec :: Int -> HsDocString -> ShowS

show :: HsDocString -> String

showList :: [HsDocString] -> ShowS

Outputable HsDocString

Defined in HsDoc

Methods

ppr :: HsDocString -> SDoc

pprPrec :: Rational -> HsDocString -> SDoc

Binary HsDocString

Defined in HsDoc

Methods

put_ :: BinHandle -> HsDocString -> IO ()

put :: BinHandle -> HsDocString -> IO (Bin HsDocString)

get :: BinHandle -> IO HsDocString

type LHsDocString = Located HsDocString

Located Haskell Documentation String

mkHsDocString :: String -> HsDocString

mkHsDocStringUtf8ByteString :: ByteString -> HsDocString

Create a HsDocString from a UTF8-encoded ByteString.

unpackHDS :: HsDocString -> String

hsDocStringToByteString :: HsDocString -> ByteString

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

ppr_mbDoc :: Maybe LHsDocString -> SDoc

appendDocs :: HsDocString -> HsDocString -> HsDocString

Join two docstrings.

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

concatDocs :: [HsDocString] -> Maybe HsDocString

Concat docstrings with two newlines in between.

Empty docstrings are skipped.

If all inputs are empty, Nothing is returned.

newtype DeclDocMap

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

Constructors

DeclDocMap (Map Name HsDocString)

Instances

Outputable DeclDocMap

Defined in HsDoc

Methods

ppr :: DeclDocMap -> SDoc

pprPrec :: Rational -> DeclDocMap -> SDoc

Binary DeclDocMap

Defined in HsDoc

Methods

put_ :: BinHandle -> DeclDocMap -> IO ()

put :: BinHandle -> DeclDocMap -> IO (Bin DeclDocMap)

get :: BinHandle -> IO DeclDocMap

emptyDeclDocMap :: DeclDocMap

newtype ArgDocMap

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

Constructors

ArgDocMap (Map Name (Map Int HsDocString))

Instances

Outputable ArgDocMap

Defined in HsDoc

Methods

ppr :: ArgDocMap -> SDoc

pprPrec :: Rational -> ArgDocMap -> SDoc

Binary ArgDocMap

Defined in HsDoc

Methods

put_ :: BinHandle -> ArgDocMap -> IO ()

put :: BinHandle -> ArgDocMap -> IO (Bin ArgDocMap)

get :: BinHandle -> IO ArgDocMap

emptyArgDocMap :: ArgDocMap