Data.GI.GIR.Documentation

Parsing of documentation nodes.

Documentation

data 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

Methods

(==) :: Documentation -> Documentation -> Bool

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

Ord Documentation

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

Methods

showsPrec :: Int -> Documentation -> ShowS

show :: Documentation -> String

showList :: [Documentation] -> ShowS

queryDocumentation :: Element -> Documentation

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