This module defines procedures to retrieve data from Guile Scheme libraries (e.g. the names and attributes of their Scheme modules and the objects these modules export). This data is then passed to template procedures to render API documentation in different formats. See, for example, the templates used to work with the Texinfo format: (documenta templates stexi).
This module provides the following interface.
Return the symbols provided by the interface.
interface (interface): A module’s <interface> record as
returned by Guile’s procedure resolve-interface.
Return value (list of symbols): Where every symbol identifies a public object exported by the interface.
Convert the given Scheme file path into a module name.
file-path (string): Absolute path to Guile Scheme module file. For example: ‘/home/user/project-x/libx/module-a.scm’.
lib-parent-path (string): Absolute path to the directory containing the library file-path belongs to. For example: ‘/home/user/project-x/’.
Return value (symbol): The name of the module. For example:
(libx module-a).
Return a list of paths to Scheme files stored in the directory.
Scheme files are identified by their .scm extension.
directory (string): Absolute path to a directory containing a Guile Scheme library.
Return value (list of strings): A list where every element represents a path to a Scheme file.
Return the API objects grouped by kind.
A kind can be one of the following: macros, procedures, record types, variables.
interface (interface): An <interface> record as returned
by Guile’s procedure resolve-interface.
Return value (alist): Association list where every entry corresponds to a kind of object and a list of its members. Only groups with members are returned.
Get the value of field from record.
record (Guile record or SRFI 9 record): A record of any type.
field (symbol): The name of the field.
Return value (anything): The value of the field.
If the FIELD does not exist, a no-such-field exception is raised.