Common Lisp Package: DEFDOC

Structured documentation definition

README:

FUNCTION

Public

Undocumented

COLLECT-ALL-SYMBOLS (PACKAGE &REST FILTERS)

COLLECT-DOCUMENTED-SYMBOLS (PACKAGE &REST FILTERS)

COLLECT-EXPORTED-SYMBOLS (PACKAGE &REST FILTERS)

COLLECT-NAMED-OUTPUT (NAME)

COLLECT-TARGET-TYPE (TARGET-NAME &REST FILTERS)

PROCESS-LATEX-DOCUMENT (DIRECTORY-PATH BARE-NAME &KEY BIBTEX INDEX)

WRITE-DOCTYPE-LATEX (DOCTYPE &KEY (ECHO NIL ECHO-SUPP) (DIR *DEFDOC-LATEX-DEFAULT-DIRECTORY*) (STYLE 'LATEX-STYLE))

WRITE-LATEX-OUTPUT (NAME &KEY (TABLE-OF-CONTENTS NIL) (INDEX NIL) (ECHO (NAMED-FUNCTION WRITE-LATEX-OUTPUT-NOP (LAMBDA ()))) (STYLE 'LATEX-STYLE) (DIRECTORY ./) (FILE NIL FILE-SUPP-P) STANDALONE)

WRITE-PACKAGE-SPECS-LATEX (PACKAGE-SPECIFIER &KEY (ECHO NIL ECHO-SUPP) (DIRECTORY *DEFDOC-LATEX-DEFAULT-DIRECTORY*) (STYLE 'LATEX-STYLE) (PACKAGE-STYLE T) INCLUDE-DOCTYPES)

WRITE-SPEC-LATEX (NAME TARGET-TYPE &KEY (STYLE 'LATEX-STYLE) (DIRECTORY *DEFDOC-LATEX-DEFAULT-DIRECTORY*) (FILE NIL FILE-SUPP-P))

MACRO

Public

DEF-DOCUMENTATION (NAME-OR-SPEC &BODY BODY)

Doc doc doc

Undocumented

AFTERMATTER (&REST KEYARGS &KEY &ALLOW-OTHER-KEYS)

COLLECT-DOC (OPTIONS &REST FORMS)

COLLECT-DOCSPEC (SYMBOL TYPE &KEY (STYLE NIL STYLE-SUPP-P) &ALLOW-OTHER-KEYS)

COLLECT-GROUPS-BY-LABEL ((LABEL-NAME &KEY (PACKAGE NIL PACKAGE-SUPP-P) GROUPS EXHAUSTIVE &ALLOW-OTHER-KEYS) &BODY FORMS)

COLLECT-OUTPUT (NAME-OR-NAMESPEC OPTIONS &REST FORMS)

COLLECT-SYMBOLS (PACKAGE SYMBOL-LIST &KEY FILTERS)

DEF-BARE-STRING-ELEMENT-TAG (TAG &KEY (PACKAGE NIL PACKAGE-SUPP-P) (SPEC-TYPE NIL SPEC-SUPP-P))

DEF-DOC-TAG (TAG (&KEY (PACKAGE NIL PACKAGE-SUPP-P) (STYLE T)) &KEY FORMATTER (SORT 0))

DEF-ELEMENT (NAME (NEW-CLASS &KEY (CLASS 'STANDARD-DOC-ELEMENT) (PACKAGE (GENSYM) PACKAGE-SUPP-P) (SPEC (GENSYM) SPEC-SUPP-P) (ARG-LIST (GENSYM) ARG-LIST-SUPP-P) (ARGS NIL ARGS-SUPP-P)) SLOTS &BODY BODY)

DEF-LABEL-CONFIG ((&KEY (LABEL NIL LABEL-SUPP-P) (STYLE T) (OUTPUT-FRAMEWORK T) (PACKAGE NIL PACKAGE-SUPP-P) &ALLOW-OTHER-KEYS) &BODY FORMS)

DEF-LATEX-STYLE-CLASS (NAME SUPERCLASSES FIELDS (&REST KEYVALS &KEY (USEPACKAGE NIL USEPACKAGE-SUPP-P) (SECNUMDEPTH NIL SECNUMDEPTH-SUPP-P) (PRIMARY-TOCDEPTH NIL PRIMARY-TOCDEPTH-SUPP-P) (CONTEXTUALIZED-PARSKIP NIL CONTEXTUALIZED-PARSKIP-SUPP-P) (PARSKIP NIL PARSKIP-SUPP-P) (PARINDENT NIL PARINDENT-SUPP-P) &ALLOW-OTHER-KEYS) &BODY CLASS-FORMS)

DEF-OUTPUT-CLASS (NAME-OR-SPEC &BODY FORMS)

DEF-PROPERTY-LABEL (NAME OPTIONS &BODY BODY)

DEF-STANDARD-STYLE-CLASS (NAME SUPERCLASSES FIELDS (&REST KEYVALS &KEY &ALLOW-OTHER-KEYS) &BODY CLASS-FORMS)

DEF-STYLE-CLASS (NAME SUPERCLASSES FIELDS (&KEY &ALLOW-OTHER-KEYS) &BODY CLASS-FORMS)

DEF-TARGET-TYPE (NAME (&KEY (CLASS 'STANDARD-DOC-TARGET) (CAPITALIZED NIL CAPITALIZED-SUPP-P) (LOWER-CASE NIL LOWER-CASE-SUPP-P) SYMBOL-DEFINITION-NOCHECK (SYMBOL-DEFINITION-CHECKER NIL SYMBOL-DEFINITION-CHECKER-SUPP-P)) &BODY FORMS)

ENSURE-API-DOCUMENTATION (PACKAGE &KEY ERROR WARNING INTERNAL DEFDOC)

GENERIC-FUNCTION

Public

Undocumented

CANDIDATE-HOME-PACKAGES (STYLE TARGET-TYPE SPEC)

FORMAT-ITEMIZED-LIST-END (STYLE STREAM)

FORMAT-ITEMIZED-LIST-ITEM-END (STYLE STREAM)

FORMAT-ITEMIZED-LIST-ITEM-START (STYLE STREAM)

FORMAT-ITEMIZED-LIST-START (STYLE STREAM)

GET-FILENAME-EXTENSION (STYLE OUTPUT-NAME DIRECTORY FILE-NAME-ROOT &ALLOW-OTHER-KEYS)

GET-LATEX-PRIMARY-TOCDEPTH (STYLE ITEM)

GET-LATEX-SECNUMDEPTH (STYLE ITEM)

LATEX-PARINDENT (G366 G367)

LATEX-PARSKIP (G339 G340)

WRITE-OUTPUT (STYLE OUTPUT-NAME DIRECTORY FILE-NAME-ROOT &KEY (ECHO (NAMED-FUNCTION WRITE-PLAINTEXT-OUTPUT-NOP (LAMBDA ()))) TABLE-OF-CONTENTS INDEX &ALLOW-OTHER-KEYS)

SLOT-ACCESSOR

Public

Undocumented

SYMBOL-HOMES (OBJECT)

SETFSYMBOL-HOMES (NEW-VALUE OBJECT)

USE-INTERNAL-NAMES (OBJECT)

SETFUSE-INTERNAL-NAMES (NEW-VALUE OBJECT)

VARIABLE

Public

Undocumented

*AFTERMATTER-TOCDEPTH*

*DEFAULT-PRIMARY-TOCDEPTH*

*DEFAULT-SECNUMDEPTH*

*DEFDOC-LATEX-DEFAULT-DIRECTORY*

*LATEX-FULL-PACKAGE-ITEM-HEADER-MACRO*

*LATEX-VERBATIM-WIDTH*

CLASS

Public

Undocumented

AFTERMATTER-CONTENTS

DOCSPEC-ENUMERATE-LATEX-STYLE

DOCSPEC-FANCY-HEADER-LATEX-STYLE

DOCSPEC-ITEMIZE-LATEX-STYLE

DOCSPEC-LIST-LATEX-STYLE

DOCSPEC-PAR-LATEX-STYLE

FULL-PACKAGE-LATEX-STYLE-MIXIN

HTML-STYLE

ITEMIZED-LIST-STYLE

LATEX-STYLE

PLAINTEXT-STYLE

SYMBOL-HOMING-STYLE