haskell-gi-0.24.0: Generate Haskell bindings for GObject Introspection capable libraries
Safe HaskellNone
LanguageHaskell2010

Data.GI.GIR.Documentation

Description

Parsing of documentation nodes.

Synopsis

Documentation

data Documentation Source #

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

queryDocumentation :: Element -> Documentation Source #

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