Package: atdoc

Function generate-info-documentation

Lambda List

generate-info-documentation (packages directory &key name title include-slot-definitions-p)


packages -- List of package designators. Documentation will be generated for these packages.
directory -- A pathname specifying a directory. All output files and temporary data will be written to this directory, which must already exist.
title -- This string will be used as the document's title.
include-slot-definitions-p -- A boolean.

Return Value

The pathname of the generated file documentation .pdf, or nil.


Generates Info documentation for packages.

With run-tex-p (the default), pdflatex is run automatically to generate a PDF file.

With include-slot-definition-p, class documentation will include a list of direct slots.