Safe Haskell | None |
---|---|
Language | Haskell98 |
Render an abstract representation of documentation (as produced
by parseGtkDoc
) as Haddock formatted documentation.
- deprecatedPragma :: Text -> Maybe DeprecationInfo -> CodeGen ()
- writeDocumentation :: RelativeDocPosition -> Documentation -> CodeGen ()
- data RelativeDocPosition
- writeHaddock :: RelativeDocPosition -> Text -> CodeGen ()
- writeArgDocumentation :: Arg -> CodeGen ()
- writeReturnDocumentation :: Callable -> Bool -> CodeGen ()
- addModuleDocumentation :: Documentation -> CodeGen ()
Documentation
deprecatedPragma :: Text -> Maybe DeprecationInfo -> CodeGen () Source #
Write the deprecation pragma for the given DeprecationInfo
, if
not Nothing
.
writeDocumentation :: RelativeDocPosition -> Documentation -> CodeGen () Source #
Write the given documentation into a Haddock comment.
data RelativeDocPosition Source #
Where is the documentation located with respect to the relevant
symbol, useful for determining whether we want to start with |
or ^
.
writeHaddock :: RelativeDocPosition -> Text -> CodeGen () Source #
Like writeDocumentation
, but allows us to pass explicitly the
Haddock comment to write.
writeArgDocumentation :: Arg -> CodeGen () Source #
Write the documentation for the given argument.
writeReturnDocumentation :: Callable -> Bool -> CodeGen () Source #
Write the documentation for the given return value.
addModuleDocumentation :: Documentation -> CodeGen () Source #
Add the given text to the module-level documentation for the module being generated.