Common Lisp Package: DEFDOC-CONTROL-API

Programmatic control of document generation.

README:

FUNCTION

Public

Undocumented

ADJOIN-BLOCKS (BLOCK1 BLOCK2)

BRACKET-WITH (LINES PREFIX SUFFIX &OPTIONAL (PAD NIL))

COMPILE-SPEC (NAME TARGET-TYPE SPEC-ARGS FORMS)

FLOW (FORMATTER STYLE TARGET-TYPE ARTIFACTS MAX)

FORMAT-OUTPUT-CONTENTS-ACTUAL (STREAM STYLE OUTPUT &REST KEYARGS &KEY &ALLOW-OTHER-KEYS)

GET-DOC-HASH-OF-TARGET-TYPE (TYPE)

GET-DOC-SPEC (NAME TYPE)

GET-DOC-SPECS (NAME)

GET-DOC-TAGS (NAME TYPE)

GET-DOC-TARGET-TYPES (&OPTIONAL (SYM NIL SYM-SUPP-P))

GET-LABELDEF (NAME)

GET-TARGET-TYPE (TYPE &OPTIONAL NOERROR)

GET-TARGET-TYPE-DOCSPECS (SYM)

INDENT-BY (LINES LENGTH)

INDENT-WITH (LINES PREFIX &KEY SKIP-FIRST SKIPS)

WHITESPACE-P (CHAR)

WIDTH (LINES)

MACRO

Public

Undocumented

NAMED-FUNCTION (NAME LAMBDA-EXPRESSION)

WITH-DIV-WRAPPER ((STREAM TAG) &BODY BODY)

WITH-SPAN-WRAPPER ((STREAM TAG) &BODY BODY)

WITH-UNPACKED-STANDARD-SPEC ((SELF INTRO INTRO-SUPP-P PARAMS PARAMS-SUPP-P BLURB BLURB-SUPP-P DETAILS DETAILS-SUPP-P CALLSPEC) INSTANCE &BODY FORMS)

GENERIC-FUNCTION

Public

Undocumented

CALLSPEC-ITEM-TO-LINES (STYLE TARGET-TYPE ITEM MAX &OPTIONAL STACK)

CALLSPEC-PREFIX (STYLE TARGET-TYPE SPEC WIDTH CALLING)

CALLSPEC-SUFFIX (STYLE TARGET-TYPE SPEC WIDTH CALLING)

CALLSPEC-TO-LINES (STYLE TARGET-TYPE SPEC WIDTH &OPTIONAL CALLING)

CANONICALIZE-ELEMENT (ELEMENT)

CHECK-STANDARD-DOCSPEC-DETAILS-SEP (STYLE TYPE SPEC STREAM &ALLOW-OTHER-KEYS)

COMPILE-ELEMENT (PACKAGE SPEC ARGS)

COMPILE-STRING-ELEMENT (PACKAGE SPEC STRING)

ELEMENT-TYPE-P (ELEM)

FORMAT-CONTENT-ANCHOR (STREAM STYLE OUTPUT BASE-LINK)

FORMAT-DEFAULT-OUTPUT-CONTENTS-SEP (STYLE STREAM SPEC OBJ1 OBJ2)

FORMAT-DOC (STREAM STYLE SPEC &KEY (WIDTH 78) BASE-LINK &ALLOW-OTHER-KEYS)

FORMAT-DOC-CONTENT-ITEM (STREAM STYLE OUTPUT &ALLOW-OTHER-KEYS)

FORMAT-DOC-CONTENT-ITEMS (STREAM STYLE OUTPUT &ALLOW-OTHER-KEYS)

FORMAT-DOCSPEC (STREAM STYLE SPEC TYPE &KEY (WIDTH 78) &ALLOW-OTHER-KEYS)

FORMAT-DOCSPEC-AFTERMATTER-MARK (STYLE MARK STREAM &ALLOW-OTHER-KEYS)

FORMAT-DOCSPEC-ELEMENT (STYLE TARGET-TYPE ELEMENT STREAM &KEY (WIDTH 80) IN-SEQ &ALLOW-OTHER-KEYS)

FORMAT-HTML-OUTPUT-INDEX-PAGE-BODY (STYLE OUTPUT OUT TOP BASE-LINK &ALLOW-OTHER-KEYS)

FORMAT-HTML-OUTPUT-INDEX-PAGE-HEADER-BLOCK (STYLE OUTPUT OUT TOP BASE-LINK &ALLOW-OTHER-KEYS)

FORMAT-HTML-OUTPUT-INDEX-PAGE-HEADERS (STYLE OUTPUT OUT TOP BASE-LINK &ALLOW-OTHER-KEYS)

FORMAT-LATEX-PRE-OUTPUT-LEADER-MATERIAL (STYLE STREAM OUTPUT &ALLOW-OTHER-KEYS)

FORMAT-LATEX-PRECONTENTS (STYLE ITEM STREAM)

FORMAT-OUTPUT-CONTENTS-SEP (STYLE STREAM SPEC OBJ1 OBJ2 &ALLOW-OTHER-KEYS)

FORMAT-OUTPUT-LEADER-DOCSPEC (STYLE LEADER STREAM)

FORMAT-OUTPUT-LEADER-MATERIAL (STYLE STREAM OUTPUT &ALLOW-OTHER-KEYS)

FORMAT-OUTPUT-LEADER-SEP (STYLE STREAM OUTPUT)

FORMAT-OUTPUT-LEADER-TITLE (STYLE STREAM OUTPUT &KEY TOP &ALLOW-OTHER-KEYS)

FORMAT-OUTPUT-POSTITEM (STYLE STREAM OUTPUT SPEC &ALLOW-OTHER-KEYS)

FORMAT-OUTPUT-PREITEM (STYLE STREAM OUTPUT SPEC &ALLOW-OTHER-KEYS)

FORMAT-OUTPUT-TRAILER-DOCSPEC (STYLE TRAILER STREAM)

FORMAT-OUTPUT-TRAILER-MATERIAL (STYLE STREAM OUTPUT &ALLOW-OTHER-KEYS)

FORMAT-SEQUENCE-ELEMENT-SEPARATOR (STYLE TARGET-TYPE SPEC ELEMENT1 ELEMENT2 STREAM &ALLOW-OTHER-KEYS)

FORMAT-STANDARD-DOCSPEC-CALLSPEC (STYLE TYPE SPEC STREAM &KEY MAX-WIDTH &ALLOW-OTHER-KEYS)

FORMAT-STANDARD-DOCSPEC-DETAILS-SEP (STYLE TYPE SPEC STREAM &ALLOW-OTHER-KEYS)

FORMAT-STANDARD-DOCSPEC-LITERAL-TEXT (STYLE TEXT STREAM &ALLOW-OTHER-KEYS)

FORMAT-STANDARD-DOCSPEC-PARAM-LIST (STYLE TYPE SPEC STREAM &ALLOW-OTHER-KEYS)

FORMAT-STANDARD-DOCSPEC-PARAM-LIST-ITEM (STYLE TYPE SPEC NAME SUBSPEC STREAM &ALLOW-OTHER-KEYS)

FORMAT-STANDARD-DOCSPEC-PARAM-LIST-ITEM-START (STYLE TYPE SPEC NAME STREAM &ALLOW-OTHER-KEYS)

FORMAT-STANDARD-DOCSPEC-PARAM-LIST-ITEM-STOP (STYLE TYPE SPEC NAME STREAM &ALLOW-OTHER-KEYS)

FORMAT-STANDARD-DOCSPEC-PARAM-LIST-START (STYLE TYPE SPEC STREAM &ALLOW-OTHER-KEYS)

FORMAT-STANDARD-DOCSPEC-PARAM-LIST-STOP (STYLE TYPE SPEC STREAM &ALLOW-OTHER-KEYS)

FORMAT-TAG (STYLE PACKAGE TAG STREAM)

GET-COMPILED-LABELDEF (PACKAGE NAME OPTIONS FORMS)

GET-DEFAULT-CALLSPEC-BLOCK-WIDTH (STYLE TARGET-TYPE SPEC)

GET-ELEMENT-FOR-DOCSPEC-FORMAT (STYLE TARGET-TYPE SPEC ELEMENT DATUM)

GET-HTML-DISAMBIGUATOR (ITEM)

GET-INCLUDED-OUTPUTSET-STYLE (OUTER-STYLE INNER-STYLE CONTAINED)

GET-LABEL-CLASS (PACKAGE NAME OPTIONS FORMS)

GET-LABEL-SECTION-ORDER (LABEL VALUE OUTPUT)

GET-LABEL-SECTION-ORDER-SUPP-P (LABEL VALUE OUTPUT)

GET-LABEL-SECTION-TITLE (LABEL VALUE OUTPUT)

GET-LABEL-SECTION-TITLE-SUPP-P (LABEL VALUE OUTPUT)

GET-LABEL-SYMBOL-VALUE-TRANSLATION (LABELED LABEL SYMBOL)

GET-LATEX-DOCUMENT-CLASS (STYLE ITEM)

GET-LATEX-OUTPUT-FILE-NAME (STYLE USAGE NAME)

GET-LATEX-USEPACKAGE-SPECS (STYLE ITEM)

GET-OUTPUT-UNIT-AUTHOR (O)

GET-OUTPUT-UNIT-LEADER (O)

GET-OUTPUT-UNIT-SHORT-TITLE (O)

GET-OUTPUT-UNIT-TITLE (O)

GET-OUTPUT-UNIT-TRAILER (O)

GET-SPEC-CLASS (PACKAGE NAME FORMS)

HTML-FREE-PARAGRAPH-DOCSPEC-ELEMENT (E)

INDEX-LISP-NAME (STYLE NAME KIND)

LABEL-VALUE (LABELED NAME)

LOCATE-PACKAGE-HOME (STYLE TARGET-TYPE SPEC SYMBOL)

OUTPUT-LINES (STYLE TARGET-TYPE SPEC WIDTH)

PACKAGE-EXPORTS-P (PACKAGE SYMBOL)

PACKAGE-LIST-ENTRY (STYLE SPEC GROUP ENTRY STREAM)

PACKAGE-LIST-GROUP-HEADER (STYLE SPEC GROUP STREAM)

PACKAGE-LIST-OVERALL-HEADER (STYLE SPEC STREAM)

PROCESS-STANDARD-LABELDEF-FORM (LABELDEF PACKAGE FORM-HEAD FORM-ARGS)

SPACEHEADED-ELEMENT (ELEMENT)

STRING-IMPLICIT-SYMBOL-HEAD (PACKAGE SPEC STRING)

TAG-SORT (STYLE PACKAGE TAG)

TRAVERSE-AND-WRITE-OUTPUT-PAGES (STYLE OUTPUT PATHNAME &KEY (CONTEXT NIL) &ALLOW-OTHER-KEYS)

WRITE-HTML-OUTPUT-INDEX-PAGE (STYLE OUTPUT STREAM BASE-LINK &ALLOW-OTHER-KEYS)

SLOT-ACCESSOR

Public

Undocumented

CAPITALIZED-TARGET-NAME (OBJECT)

SETFCAPITALIZED-TARGET-NAME (NEW-VALUE OBJECT)

CODE-ELEMENT-STRING (OBJECT)

DOC-LABEL-NAME (LABEL)

DOCSPEC-BLURB (OBJECT)

SETFDOCSPEC-BLURB (NEW-VALUE OBJECT)

DOCSPEC-CALLSPECS (OBJECT)

SETFDOCSPEC-CALLSPECS (NEW-VALUE OBJECT)

DOCSPEC-DEPRECATED (OBJECT)

SETFDOCSPEC-DEPRECATED (NEW-VALUE OBJECT)

DOCSPEC-DESCRIPTIVE (OBJECT)

SETFDOCSPEC-DESCRIPTIVE (NEW-VALUE OBJECT)

DOCSPEC-DETAILS (OBJECT)

SETFDOCSPEC-DETAILS (NEW-VALUE OBJECT)

DOCSPEC-INTRO (OBJECT)

SETFDOCSPEC-INTRO (NEW-VALUE OBJECT)

DOCSPEC-PARAMS (OBJECT)

SETFDOCSPEC-PARAMS (NEW-VALUE OBJECT)

DOCSPEC-SELF (OBJECT)

DOCSPEC-TAGS (OBJECT)

SETFDOCSPEC-TAGS (NEW-VALUE OBJECT)

DOCSPEC-TARGET-TYPE (OBJECT)

EMPHASIZED-SPEC (OBJECT)

FILE-ELEMENT-ASDF (OBJECT)

SETFFILE-ELEMENT-ASDF (NEW-VALUE OBJECT)

FILE-ELEMENT-PATH (OBJECT)

SETFFILE-ELEMENT-PATH (NEW-VALUE OBJECT)

FILE-ELEMENT-RE-TAG (OBJECT)

SETFFILE-ELEMENT-RE-TAG (NEW-VALUE OBJECT)

GET-CALLSPEC-HOLDER-ITEMS (OBJECT)

GET-CALLSPEC-KEYARG-ARG (OBJECT)

GET-CALLSPEC-KEYARG-KEY (OBJECT)

GET-CALLSPEC-KEYHEADED-FORMS (OBJECT)

GET-CALLSPEC-KEYHEADED-KEY (OBJECT)

GET-CALLSPEC-OPTIONAL-OPTION (OBJECT)

GET-CALLSPEC-SEQUENCE-OF-REPEATED (OBJECT)

GET-GROUPED-OUTPUT-GROUP (OBJECT)

GET-GROUPED-OUTPUT-LABELDEF (OBJECT)

INLINE-ELEMENT-STRING (OBJECT)

LABEL-VALUES (LABELED-ENTITY)

LATEX-ELEMENT-LATEX (OBJECT)

LISP-NAME (OBJECT)

LISP-NAME-KIND (OBJECT)

LIST-ELEMENT-ENV-TAG (OBJECT)

LIST-ELEMENT-OPTIONS (OBJECT)

LIST-ELEMENT-SPECS (OBJECT)

LOWER-CASE-TARGET-NAME (OBJECT)

SETFLOWER-CASE-TARGET-NAME (NEW-VALUE OBJECT)

OUTPUT-CONTENTS-CONTENTS (OBJECT)

SETFOUTPUT-CONTENTS-CONTENTS (NEW-VALUE OBJECT)

OUTPUT-CONTENTS-STYLE (OBJECT)

OUTPUT-ELEM-NAME (OBJECT)

SETFOUTPUT-ELEM-NAME (NEW-VALUE OBJECT)

OUTPUT-ELEM-STYLE (OBJECT)

SETFOUTPUT-ELEM-STYLE (NEW-VALUE OBJECT)

OUTPUT-ELEM-STYLE-SUPP-P (OBJECT)

SETFOUTPUT-ELEM-STYLE-SUPP-P (NEW-VALUE OBJECT)

PARAGRAPHLIST-ELEMENT-ITEMS (OBJECT)

REFERENCED-NAME (OBJECT)

SEQUENCE-ELEMENT-ITEMS (OBJECT)

STANDARD-CALLSPEC-BODY (OBJECT)

SETFSTANDARD-CALLSPEC-BODY (NEW-VALUE OBJECT)

STANDARD-CALLSPEC-BODY-SUPP (OBJECT)

SETFSTANDARD-CALLSPEC-BODY-SUPP (NEW-VALUE OBJECT)

STANDARD-CALLSPEC-KEY (OBJECT)

SETFSTANDARD-CALLSPEC-KEY (NEW-VALUE OBJECT)

STANDARD-CALLSPEC-KEY-SUPP (OBJECT)

SETFSTANDARD-CALLSPEC-KEY-SUPP (NEW-VALUE OBJECT)

STANDARD-CALLSPEC-MANDATORY (OBJECT)

SETFSTANDARD-CALLSPEC-MANDATORY (NEW-VALUE OBJECT)

STANDARD-CALLSPEC-OPTIONAL (OBJECT)

SETFSTANDARD-CALLSPEC-OPTIONAL (NEW-VALUE OBJECT)

STANDARD-CALLSPEC-OPTIONAL-SUPP (OBJECT)

SETFSTANDARD-CALLSPEC-OPTIONAL-SUPP (NEW-VALUE OBJECT)

TEXT-ELEMENT-TEXT (OBJECT)

VARIABLE

Public

Undocumented

*DEFAULT-ELEMENT-CLASS*

*DEFDOC-LATEX-DEFAULT-DIRECTORY*

*DOCSTRING-STYLE*

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

*OUTPUT-NESTING-DEPTH*

*SPEC-CLASS*

CLASS

Public

Undocumented

BIBTEX-NAME-ELEMENT

CALLSPEC-BAG-OF

CALLSPEC-KEYARG

CALLSPEC-KEYHEADED

CALLSPEC-ONE-OF

CALLSPEC-OPTIONAL

CALLSPEC-SEQUENCE-OF

DOC-LABEL

DOC-SPEC

DOCSPEC-ELEMENT

EXPLICIT-DOC-ELEMENT

FULL-PACKAGE-LATEX-STYLE-MIXIN

GROUPED-OUTPUT-CONTENTS

LABELED

LATEX-NAME-ELEMENT

MACROLIST-CALLSPEC

OUTPUT-CONTENTS

PACKAGE-LIST-LATEX-MIXIN

PLAINTEXT-METHODS-COVERAGE

STANDARD-CALLSPEC

STANDARD-CODE

STANDARD-DOC-ELEMENT

STANDARD-DOC-LABEL

STANDARD-DOC-SPEC

STANDARD-DOC-TARGET

STANDARD-DOCSTRING-STYLE

STANDARD-ELEMENTS-STYLE-COVERAGE

STANDARD-EMPHASIZED

STANDARD-ENUMERATE

STANDARD-FILE-ELEMENT

STANDARD-FILLIN-PLACE

STANDARD-INLINE

STANDARD-ITEMIZE

STANDARD-LATEX

STANDARD-LISP-NAME

STANDARD-OUTPUTSET-ELEMENT

STANDARD-PARAGRAPH-LIST

STANDARD-PLAIN-TEXT

STANDARD-REFERENCE

STANDARD-SEQUENCE

STANDARD-SIMPLE-LIST-ENVIRONMENT

STYLE-COVERAGE