| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
HsDoc
Synopsis
- data HsDocString
- type LHsDocString = Located HsDocString
- mkHsDocString :: String -> HsDocString
- mkHsDocStringUtf8ByteString :: ByteString -> HsDocString
- 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 (Map Int HsDocString))
- emptyArgDocMap :: ArgDocMap
Documentation
data HsDocString Source #
Haskell Documentation String
Internally this is a UTF8-Encoded ByteString .
Instances
Instance details
Defined in HsDoc
Instance details
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 #
Instance details
Defined in HsDoc
Methods
showsPrec :: Int -> HsDocString -> ShowS #
show :: HsDocString -> String #
showList :: [HsDocString] -> ShowS #
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 .
unpackHDS :: HsDocString -> String Source #
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
Instances
Docs for arguments. E.g. function arguments, method arguments.