Data.GI.CodeGen.Haddock

Render an abstract representation of documentation (as produced by parseGtkDoc) as Haddock formatted documentation.

Documentation

deprecatedPragma :: Text -> Maybe DeprecationInfo -> CodeGen ()

Write the deprecation pragma for the given DeprecationInfo, if not Nothing.

writeDocumentation :: RelativeDocPosition -> Documentation -> CodeGen ()

Write the given documentation into generated code.

data RelativeDocPosition

Where is the documentation located with respect to the relevant symbol, useful for determining whether we want to start with | or ^.

Constructors

DocBeforeSymbol

DocAfterSymbol

writeHaddock :: RelativeDocPosition -> Text -> CodeGen ()

Like writeDocumentation, but allows us to pass explicitly the Haddock comment to write.

writeArgDocumentation :: Arg -> CodeGen ()

Write the documentation for the given argument.

writeReturnDocumentation :: Callable -> Bool -> CodeGen ()

Write the documentation for the given return value.

addSectionDocumentation :: HaddockSection -> Documentation -> CodeGen ()

Add the given text to the documentation for the section being generated.