This module defines procedures that structure API data as stexi (symbolic texinfo), which can later be translated into Texinfo and integrated with the rest of the Texinfo documentation of a given software project.
This module provides the following interface.
Return the API binding name-value as an stexi definition.
name (symbol): The name of the binding. For example, the name of a variable, the name of a procedure, etc.
value (anything): Any kind of object. For example, a string, a list, a procedure, a record, etc.
Return value (stexi): An stexi definition appropriate for the type of value.
Return a library API as an stexi chapter.
sections (list of stexi): A list where every item is an stexi section.
Return value (stexi): A chapter documenting a library’s API.
Return the module’s commentary or description as stexi.
module-name (list of symbols): For example: '(mylib
amodule).
Return value (stexi): An stexi fragment.
Return the module documentation as an stexi section.
module-name (list of symbols): For example: '(mylib
amodule).
Return value (stexi): A section documenting a module’s API.
Return the parameters of the given procedure as a string.
proc (procedure): A procedure object.
Return value (string): A string listing the names of all the required, optional, keyword, and rest of parameters of the procedure. Default values for optional and keyword parameters are not included.