Package: atdoc
Function generate-html-documentation
Lambda List
generate-html-documentation (packages directory &key author author-url date index-title heading css ico logo single-page-p paginate-section-p include-slot-definitions-p include-internal-symbols-p)
Arguments
Return Value
The pathname of the generated file index.xml.
Details
Generates HTML documentation for packages.
With single-page-p, all documentation is assembled as a single page called index.html. Otherwise, index.html will include only a symbol index and a summary of each package, with links to other pages.
With include-slot-definitions-p, pages for symbols that are not exported will be included, so that documentation for exported symbols can safely refer to internal pages (but internal symbols will not be included in the symbol index automatically). This option has no effect if single-page-p is enabled.
With include-slot-definition, class documentation will include a list of direct slots.
With single-page-p, all documentation is assembled as a single page called index.html. Otherwise, index.html will include only a symbol index and a summary of each package, with links to other pages.
With include-slot-definitions-p, pages for symbols that are not exported will be included, so that documentation for exported symbols can safely refer to internal pages (but internal symbols will not be included in the symbol index automatically). This option has no effect if single-page-p is enabled.
With include-slot-definition, class documentation will include a list of direct slots.