Index Class hierarchy All packages
Classes Global Variables Generic functions Methods Functions Macros Export Interface
Class hierarchy in package LISP-DOCUMENTATION:
| *.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 | ||
| *CURRENT-FILENAME* | ||
| holds the filename of the file whichs is scanned | ||
| *DOCU-START-DIR* | ||
| *FORBIDDEN-FILECHARS* | ||
| characters that should not appear in pathnames, depends on OS | ||
| *INDEX-FILE* | exported | |
| filename for alphabetical index | ||
| *LOCAL-MACROS* | ||
| Bind this to an assoc list of macro expanders | ||
| *PACKAGES-FILE* | exported | |
| filename for package overview | ||
| *STYLE-FILE-ENG* | ||
| *STYLE-FILE-GER* | ||
| ERGEBNIS-LISTE | ||
| TOPO-LISTE | ||
| DOCU-ADD-TO-TABLE | ||
| docu-table docu-thing implemented in DOCU-CLASS, DOCU-FUNCTION, DOCU-MACRO, DOCU-PACKAGE, DOCU-GENERIC-FUNCTION, DOCU-SYMBOL, DOCU-TABLE, DOCU-METHOD Add a docu-thing to its correct slot in the table. | ||
| 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. | ||
| DOCU-GET-FROM-TABLE | ||
| docu-table name category implemented in DOCU-TABLE, DOCU-PACKAGE Get a docu-thing named NAME from the table. CATEGORY specifies the type of the docu-thing to look for - e.g. classes, lost-methods. | ||
| DOCU-HANDLE-TOKEN | ||
| table token type implemented in DOCU-TABLE parses token, creates instances of the appropiate class and updates the table | ||
| CREATE-FILE-NAME | ||
| something &optional mode [:HTML] creates a legal filename out of something with the right extension. Filesystem specific characters like are converted, the maximum length of a filename is guaranteed (on MacOS 30) | ||
| package [PACKAGE] &optional mode [:HTML] | ||
| DOCU-CREATE ,declared in generic function DOCU-CREATE | exported | |
| 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-BOOKSTYLE | exported | |
| 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-INTERN | ||
| filename &optional exclude creates documenation table of file filename | ||
| 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. | ||
| DOCU-GET-ALL-IN-PACKAGE | ||
| something [LIST] package [PACKAGE] returns all elements in the list (which are of class docu-type) which are in the given package | ||
| DOCU-INPACKAGE-NAME | ||
| self | ||
| DOCU-LINK | ||
| self [T] &optional mode [:HTML] | ||
| DOCU-NAME | ||
| self [T] | ||
| self [PACKAGE] | ||
| EXTRACT-SYMBOL | ||
| asymbol [STRING] &optional act-package [":cl-user"] check-for-setf-fn extracts symbolname and packagename from aSymbol and returns (symbol package) | ||
| asymbol &optional act-package [":cl-user"] check-for-setf-fn | ||
| symbols [LIST] &optional act-package [":cl-user"] check-for-setf-fn | ||
| FILENAME-WITH-EXTENSION | ||
| datei mode completes the filename with the extension which belongs to mode | ||
| datei [PACKAGE] mode | ||
| datei [STRING] mode [eql :HTML] | ||
| datei [STRING] mode [eql :TEX] | ||
| datei [STRING] mode [eql :RTF] | ||
| datei [STRING] mode [eql :NO-EXTENSION] | ||
| NAME | ||
| object | ||
| OUTFILE-PATHNAME | ||
| datei &optional directory creates a pathname of file datei with mapping mode to a file extension | ||
| datei [PATHNAME] &optional directory | ||
| datei [STRING] &optional directory | ||
| SET-MAC-CREATOR | ||
| outname mode | ||
| outname mode [eql :TEX] | ||
| outname mode [eql :HTML] | ||
| outname mode [eql :RTF] | ||
| ADD-TOPO | ||
| topo-elem nach | ||
| ADD1-TOPO | ||
| topo-elem | ||
| AKTUALISIERE-NACH | ||
| nach-liste | ||
| BAUE-ERGEBNIS-BAUM | ||
| liste elems | ||
| BAUE-ERGEBNIS-BAUM-REK | ||
| liste elems | ||
| BAUE-TOPO | ||
| data | ||
| BEARBEITE-KAND | ||
| kand-liste | ||
| CONS-TOPO-ELEM | ||
| wert nach zahl-vor | ||
| DOCU-DETOKENIZE | ||
| sexp Takes a string-tokenized version of an S-expression and returns the original S-exp | ||
| DOCU-SCAN | ||
| pathname scans file and returns a list of tokens | ||
| DOCU-SCAN-REK | ||
| token builds recursively a list of tokens from the scanstring | ||
| DRUCKE-ERGEBNIS | ||
| liste | ||
| EINFUEGEN-IN-TOPOLISTE | ||
| datum | ||
| EINFUEGEN-IN-TOPOLISTE1 | ||
| datum zeiger-elem liste | ||
| EINFUEGEN-IN-TOPOLISTE2 | ||
| datum liste | ||
| FINDE-TOPS | ||
| topo-liste | ||
| GET-ALL-LISPFILES-IN-DIRECTORY | ||
| dir &key recursive-p [ NIL ] exclude [ NIL ] | ||
| GET-TABLE | exported | |
| &optional table-class gets the current table, and changes the table class if table-class is given | ||
| INIT-VARS | ||
| nil [ NIL ] cl-user | ||
| JB=ERZEUGE-STRING | exported | |
| was wie b=erzeuge-string, nur das NIL->"NIL" und strings nach "string" | ||
| LEADER-TOPO? | ||
| topo-elem | ||
| NACH-TOPO | ||
| topo-elem | ||
| NEW-TABLE | exported | |
| &optional table-class creates a new table. useful for calling docu-create-with-existing-table and docu-create-output manually | ||
| QUOTEP | ||
| x | ||
| QUOTEP | ||
| x | ||
| READ-DOCU-STRING | ||
| obj Reads the documentation string and removes Whitespaces | ||
| SCHLEIFE? | ||
| kand-liste | ||
| SET-LANGUAGE | exported | |
| language sets the language for output | ||
| SORTIERE-TOPO | ||
| data | ||
| STRING-ATOMP | ||
| token | ||
| STRING-LISTP | ||
| token | ||
| STRING-QUOTEP | ||
| token | ||
| STRING-READERMACROP | ||
| token | ||
| STRING-STRINGP | ||
| token | ||
| SUB1-TOPO | ||
| topo-elem | ||
| WERT-TOPO | ||
| topo-elem | ||
| WHITESPACE-P | ||
| achar | ||
| ZAHL-VOR-TOPO | ||
| topo-elem | ||