| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Data.GI.GIR.Documentation
Description
Parsing of documentation nodes.
Synopsis
- data Documentation = Documentation {
- rawDocText :: Maybe Text
- sinceVersion :: Maybe Text
- queryDocumentation :: Element -> Documentation
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
| |
Instances
| Eq Documentation Source # | |
Defined in Data.GI.GIR.Documentation Methods (==) :: Documentation -> Documentation -> Bool # (/=) :: Documentation -> Documentation -> Bool # | |
| Ord Documentation Source # | |
Defined in Data.GI.GIR.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 Source # | |
Defined in Data.GI.GIR.Documentation Methods showsPrec :: Int -> Documentation -> ShowS # show :: Documentation -> String # showList :: [Documentation] -> ShowS # | |
queryDocumentation :: Element -> Documentation Source #
Parse the documentation node for the given element of the GIR file.