Safe Haskell	None
Language	Haskell98

Data.GI.GIR.Documentation

Description

Parsing of documentation nodes.

Synopsis

Documentation

Documentation for a given element. The documentation text is typically encoded in the gtk-doc format, see https://developer.gnome.org/gtk-doc-manual/ . This can be parsed with parseGtkDoc.

Constructors

Documentation
Fields rawDocText :: Maybe Text sinceVersion :: Maybe Text

Instances

Eq Documentation Source #
Methods (==) :: Documentation -> Documentation -> Bool # (/=) :: Documentation -> Documentation -> Bool #
Ord Documentation Source #
Methods compare :: Documentation -> Documentation -> Ordering # (<) :: Documentation -> Documentation -> Bool # (<=) :: Documentation -> Documentation -> Bool # (>) :: Documentation -> Documentation -> Bool # (>=) :: Documentation -> Documentation -> Bool # max :: Documentation -> Documentation -> Documentation # min :: Documentation -> Documentation -> Documentation #
Show Documentation Source #
Methods showsPrec :: Int -> Documentation -> ShowS # show :: Documentation -> String # showList :: [Documentation] -> ShowS #

Parse the documentation node for the given element of the GIR file.