---

3.2 Typelib Documentation

Procedure: typelib lib [version] [#:require?=#t] ¶

Open a new input port, whose contents describe the runtime bindings created for lib. If version is given, use that version of the typelib, otherwise the latest. If require? is true (the default), require it first.

Procedure: gir lib version ¶

Open a new file input port for the GIR metadata of LIB. VERSION applies just as with typelib, but is required.

Parameter: gir-search-path ¶

Search path, that gir searches GIR metadata in. This parameter is actually defined in (gi config).

Procedure: parse xml [documentation] ¶

Parse xml into a structure suitable for post-processing. If documentation is given, use it as a base, merging the two.

xml is expected to be a string or port containing documentation in an XML format. documentation should either be the empty list (the default) or the result of a previous parse operation.

It should be noted, that the order in which documentations are threaded through parse matters. The last xml “wins” in cases where multiple ones fill in the same value (e.g. attributes). Since GIRs has more information than typelibs, you should therefore handle typelibs first in most cases.

The result is a nodeset corresponding to the (merged) XML. However, it is stripped down to only contain nodes relevant for documentation (the exact subset may be subject to change) and also contains the non-standard scheme node for bindings created by Guile-GI.

Procedure: ->guile-procedures.txt documentation ¶

Display documentation in an guile-procedures.txt-esque style.

Procedure: ->docbook documentation ¶

Display documentation as DocBook XML.

Warning: The standard DocBook tools installable through most distributions do not handle XML, but rather SGML. Trying to post-process the results of this function with them will only end up in weird results, (potentially lots of) errors and user frustration. Use GTK-Doc instead, either directly or through xsltproc, or use your own XSLT stylesheets.