Index   Class hierarchy   All packages

LISP-Docu 1.1

Export Interface

Classes  Global Variables  Generic functions  Methods  Functions  Macros  All Symbols


Class hierarchy in package LISP-DOCUMENTATION:


Global Variables

*.HTML-MAC-CREATOR* exported
    
MacOS Filecreator/Type for Netscape Navigator
*.HTML-PATHNAME* exported
    
File extension for HTML-Files
*.RTF-MAC-CREATOR* exported
    
MacOS Filecreator/Type for MS Word
*.RTF-PATHNAME* exported
    
File extension for RTF-Files
*.TEX-MAC-CREATOR* exported
    
MacOS Filecreator/Type for OzTeX
*.TEX-PATHNAME* exported
    
File extension for TeX-Files
*CLASS-HIERARCHY-FILE* exported
    
filename for class tree
*INDEX-FILE* exported
    
filename for alphabetical index
*PACKAGES-FILE* exported
    
filename for package overview


Generic functions

DOCU-CREATE exported
    
input &key mode language directory index recursive-p exclude title
implemented in LISP-DOCUMENTATION
creates a documentation of the files given to input in the given language and mode.directory names the destination of the output files, index is a flag which indicates, if indexes should be created. recursive-p indicates if a directory in input should be scanned recursively, exclude can be a list of files and directories which should not be scanned. This method is the only one which should be called in normal cases.
DOCU-CREATE-BOOKSTYLE exported
    
input &key mode language directory only-exports recursive-p exclude title
implemented in LISP-DOCUMENTATION
creates documentation of the filenames input in the given mode and language. Mode can be :html, :tex or :rtf, language can be :d or :e. exclude can be a list of filenames and directories which are not scanned; Directory can be a path for the documentation files; only-exports is a flag, if it is T then only exported symbols are respected. Title can be a string which is title.


Methods

DOCU-CREATE ,declared in generic function DOCU-CREATEexported
    
filenames [LIST] &key mode [:HTML] language [:D] directory [NIL] index [T] recursive-p [NIL] exclude [NIL] title [NIL]
creates documentation of the filenames in the given mode and language. Mode can be :html, :tex or :rtf, language can be :d or :e. Directory can be a path for the documentation files, if index is NIL no indexes will be created else indexes are created. Title can be a string which is used as headline for some files.
    
filename [STRING] &key mode [:HTML] language [:D] directory [NIL] index [T] recursive-p [NIL] exclude [NIL] title [NIL]
creates documentation for the given file in the given mode and language. Mode can be :html, :tex or :rtf, language can be :d or :e. Directory can be a path for the documentation files, if index is NIL no indexes will be created else indexes are created. Title can be a string which is used as headline for some files.
    
filename [PATHNAME] &key mode [:HTML] language [:D] directory [NIL] index [T] recursive-p [NIL] exclude [NIL] title [NIL]
same as above
DOCU-CREATE-BOOKSTYLE ,declared in generic function DOCU-CREATE-BOOKSTYLEexported
    
filenames [LIST] &key mode [:HTML] language [:D] directory [NIL] only-exports [T] recursive-p [NIL] exclude [NIL] title [NIL]
    
filename [STRING] &key mode [:HTML] language [:D] directory [NIL] only-exports [T] recursive-p [NIL] exclude [NIL] title [NIL]
    
filename [PATHNAME] &key mode [:HTML] language [:D] directory [NIL] only-exports [T] recursive-p [NIL] exclude [NIL] title [NIL]
DOCU-CREATE-OUTPUT exported
    
&key mode [:HTML] index [T] language [:E] directory [NIL] title [NIL]
creates documentation files (in directory directory) of input files previously scanned, for each package and class one. If index is true, then Indexes of packages and classes are created.Language can be :d or :e and indicates the language of the labels.Title can be a string which is used as headline for some files.This function can be used after a call to docu-create to produce a second output without rescanning the input files.
DOCU-CREATE-OUTPUT-BOOKSTYLE exported
    
&key mode [:HTML] language [:E] directory [NIL] title [NIL] only-exports [T]
creates documentation files (in directory directory) of sources previously scanned, for each package and class one. Language can be :d or :e and indicates the language of the labels. Title can be a string which is used as headline for some files. All output files are held together by one master file which includes all other.This function can be used after a call to docu-create-bookstyle to produce a second output without rescanning the input files.
DOCU-CREATE-WITH-EXISTING-TABLE exported
    
filenames [LIST] &key recursive-p [NIL] exclude [NIL]
creates documentation for the filenames. The existing table is used, no output is generated. Can be used after docu-create to insert new files, a call to docu-create-output will create the documentation files.
    
filename [STRING] &key recursive-p [NIL] exclude [NIL]
creates documentation for the filenames. The existing table is used, no output is generated. Can be used after docu-create to insert new files, a call to docu-create-output will create the documentation files.


Functions

GET-TABLE exported
    
&optional table-class
gets the current table, and changes the table class if table-class is given
JB=ERZEUGE-STRING exported
    
was
wie b=erzeuge-string, nur das NIL->"NIL" und strings nach "string"
NEW-TABLE exported
    
&optional table-class
creates a new table. useful for calling docu-create-with-existing-table and docu-create-output manually
SET-LANGUAGE exported
    
language
sets the language for output


Macros

This package contains no exported macros.