Common Lisp Package: DEFDOC-CORE

DefDoc internal organizational package - core operations

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)

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)

WHITESPACE-P (CHAR)

Private

Undocumented

ADDRESSED-LABELCONFIG-KEYARG (KEY)

ALL-BY-DEFDOCS-STORAGE-COLLECTOR

ALL-SPECS-COLLECTOR (&OPTIONAL (RESULT (MAKE-HASH-TABLE TEST 'EQ)))

COMPILE-DOCSPEC-GATHERER (SPEC &OPTIONAL (RESULTS NIL RESULTS-SUPP-P))

COMPILE-FILTER-SPEC (SPEC SPEC-VAR)

COMPILE-PACKAGE-SYMBOL-GENERATOR (MACRONAME SPEC-ARGS WARN-UNDOC RESULTS-HASH)

DECODE-DEFDOC-SPEC (NAME-OR-SPEC)

DECODE-DOCTYPE-FORMS (FORMS)

EXTRACT-AND-REFINE-GROUP-NAMES (GROUP-HASH &KEY (ALLOWED-LIST NIL ALLOWED-LIST-SUPP-P))

FILTER-COLLECTOR (COLLECTOR FILTER)

GET-FILTER-PREDICATE (FILTER-KEYARGS)

GET-LABEL-GROUPER-CALL (LABEL-NAME GROUPS PACKAGE PACKAGE-SUPP-P EXHAUSTIVE FORMS)

GET-PACKAGES-EXPORTED-COLLECTOR (PACKAGE-NAMES &OPTIONAL (WARN-IF-UNDOC T))

GET-PACKAGES-SYMBOLS-COLLECTOR (PACKAGE-NAMES &OPTIONAL WARN-IF-UNDOC)

GET-SPECS-BY-PACKAGE-ALLSYMBOLS (PACKAGE-NAME FILTER WARN-IF-UNDOC)

GET-SPECS-BY-PACKAGE-EXPORT (PACKAGE-NAME FILTER &OPTIONAL WARN-IF-UNDOC)

GET-SPECS-BY-TARGET-TYPE (TARGET-NAME FILTER)

GET-SYMBOL-LIST-SPECS (SYMBOLS FILTER)

GET-TARGET-TYPES-COLLECTOR (TARGET-TYPE-SPECS)

GET-WRAPPED-CORE (CORE VARIABLE VARIABLE-SUPP-P)

GROUP-LIST-BY-LABEL (&KEY (GROUP-SPECS NIL GROUPS-SUPP-P) GROUPING-LABEL EXHAUSTIVE (GENERATING-THUNK #'(LAMBDA () NIL)))

GUESS-SPEC-TYPE (NAME)

MAKE-DOC-HOLDER (OPTIONS SPEC-FORMS)

RESOLVE-OUTPUTSET-STYLE (OUTER-STYLE INNER-OUTPUT-CONTAINER)

SELECT-DOCSPECS (CRITERIA)

WARN-IF-UNDOCUMENTED (SYM &KEY ERROR WARNING DEFDOC-ONLY)

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-OUTPUT-CLASS (NAME-OR-SPEC &BODY FORMS)

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

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)

NAMED-FUNCTION (NAME LAMBDA-EXPRESSION)

Private

Undocumented

COLLECTOR-UNITEF (BASE-COLLECTION NEW-COLLECTION-FORM)

COLLECTORS-UNITEF (BASE-COLLECTION NEW-COLLECTIONS)

DEF-GENERIC-FN-DEFAULT-NIL (NAME PARAMS)

DEF-GROUPED-CONTENTS-METHOD-VIA-LABEL-SPEC (GROUPED-OUTPUT-METHOD LABEL-SPEC-SUPP-METHOD LABEL-SPEC-METHOD &KEY (FULL-SPEC T))

DEF-SLOT-SUPP-PREDICATES (CLASS SLOT-AND-FUNCTION-SPECS)

DEFDOC-DEBUG (FORMAT &REST ARGS)

WITH-CONJUNCTIVE-OPTIONS ((ARG OPTIONS) ITEM &BODY BODY)

WITH-NAME-AND-FILTERS ((NAME-VAR FILTERS-VAR FORM) &BODY BODY)

GENERIC-FUNCTION

Public

Undocumented

CANONICALIZE-ELEMENT (ELEMENT)

COMPILE-ELEMENT (PACKAGE SPEC ARGS)

COMPILE-STRING-ELEMENT (PACKAGE SPEC STRING)

ELEMENT-TYPE-P (ELEM)

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-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-TAG (STYLE PACKAGE TAG STREAM)

GET-COMPILED-LABELDEF (PACKAGE NAME OPTIONS FORMS)

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

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-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)

LABEL-VALUE (LABELED NAME)

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

PACKAGE-EXPORTS-P (PACKAGE SYMBOL)

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)

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)

Private

Undocumented

ARGS (CONDITION)

COMPILE-SYMBOL-HEADED-ELEMENT (HD PACKAGE SPEC ARGS)

DEF-TYPE (CONDITION)

GET-COMPILED-LABEL-CONFIG (LABEL-DEF VALUE STYLE OUTPUT &KEY (TRAILER NIL TRAILER-SUPP-P) (LEADER NIL LEADER-SUPP-P) (ORDER NIL ORDER-SUPP-P) (TITLE NIL TITLE-SUPP-P) &ALLOW-OTHER-KEYS)

GET-ELEMENT-AGGREGATION (PACKAGE SPEC ELEMENTS)

GET-ELEMENT-CLASS (PACKAGE NAME SPEC FORMS)

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

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

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

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

GET-OUTPUT-UNIT-ORDER (O)

GIVEN (CONDITION)

HAS-SUBSORT-LABEL (LABEL-DEF)

LABEL-NAME (CONDITION)

MISSING (CONDITION)

PPRINT-OUTPUT-CONTENTS-FIELDS (O)

SET-LABEL-VALUE (LABELED NAME VALUE)

SYM (CONDITION)

TAG-SORT-WARNING-PACKAGE (CONDITION)

TAG-SORT-WARNING-STYLE (CONDITION)

TAG-SORT-WARNING-TAG (CONDITION)

TITLE (NAME)

USAGE (CONDITION)

SLOT-ACCESSOR

Public

Undocumented

CAPITALIZED-TARGET-NAME (OBJECT)

SETFCAPITALIZED-TARGET-NAME (NEW-VALUE OBJECT)

DOC-LABEL-NAME (LABEL)

DOCSPEC-SELF (OBJECT)

DOCSPEC-TAGS (OBJECT)

SETFDOCSPEC-TAGS (NEW-VALUE OBJECT)

DOCSPEC-TARGET-TYPE (OBJECT)

GET-GROUPED-OUTPUT-GROUP (OBJECT)

GET-GROUPED-OUTPUT-LABELDEF (OBJECT)

LABEL-VALUES (LABELED-ENTITY)

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)

Private

Undocumented

AUTHOR (OBJECT)

CONTENTS (OBJECT)

DOCSPEC (OBJECT)

SETFDOCSPEC (NEW-VALUE OBJECT)

DOCSTRING-INSTALLER (OBJECT)

SETFDOCSTRING-INSTALLER (NEW-VALUE OBJECT)

LEADER (OBJECT)

NAME (CONDITION)

SETFNAME (NEW-VALUE OBJECT)

OUTPUT-CONTENTS-AUTHOR (OBJECT)

SETFOUTPUT-CONTENTS-AUTHOR (NEW-VALUE OBJECT)

OUTPUT-CONTENTS-LEADER (OBJECT)

SETFOUTPUT-CONTENTS-LEADER (NEW-VALUE OBJECT)

OUTPUT-CONTENTS-SHORT-TITLE (OBJECT)

SETFOUTPUT-CONTENTS-SHORT-TITLE (NEW-VALUE OBJECT)

OUTPUT-CONTENTS-TITLE (OBJECT)

SETFOUTPUT-CONTENTS-TITLE (NEW-VALUE OBJECT)

OUTPUT-CONTENTS-TRAILER (OBJECT)

SETFOUTPUT-CONTENTS-TRAILER (NEW-VALUE OBJECT)

STANDARD-LABEL-DEFAULT-SUBSORT (OBJECT)

SETFSTANDARD-LABEL-DEFAULT-SUBSORT (NEW-VALUE OBJECT)

SYMBOL-DEFINITION-CHECKER (OBJECT)

SETFSYMBOL-DEFINITION-CHECKER (NEW-VALUE OBJECT)

TRAILER (OBJECT)

UNIT-SHORT-TITLE (OBJECT)

UNIT-TITLE (OBJECT)

VARIABLE

Public

Undocumented

*DEFAULT-ELEMENT-CLASS*

*DOCSTRING-STYLE*

*OUTPUT-NESTING-DEPTH*

*SPEC-CLASS*

Private

+DEFDOCS+

Master global hashtable of all documentation specifiers.

+DOC-TARGET-TYPES+

Master global hashtable of all documentation target specifiers.

Undocumented

*DEFDOC-DEBUG*

*DEFDOC-DEBUGGABLE*

*DOCSPEC-COMPILER-NAME*

*LABEL-CLASS*

*LABEL-COMPILER*

+ALL-SPECS-COLLECTORS+

+LABEL-DEFS+

CLASS

Public

Undocumented

AFTERMATTER-CONTENTS

DOC-LABEL

DOC-SPEC

DOCSPEC-ELEMENT

EXPLICIT-DOC-ELEMENT

GROUPED-OUTPUT-CONTENTS

LABELED

OUTPUT-CONTENTS

STANDARD-DOC-LABEL

STANDARD-DOC-TARGET

CONDITION

Private

Undocumented

ERROR-UNDOC-REPORTING-ANY

ERROR-UNDOC-REPORTING-DEFDOC-ONLY

OPTION-WITHOUT-REQUIRED-OPTION

STYLE-WARNING-UNDOC-REPORTING-ANY

STYLE-WARNING-UNDOC-REPORTING-DEFDOC-ONLY

TAG-SORT-WARNING

UNDOC-REPORTING

UNDOC-REPORTING-ANY

UNDOC-REPORTING-DEFDOC-ONLY

UNRECOGNIZED-DEFLABEL-FORM

WARNING-UNDOC-REPORTING-ANY

WARNING-UNDOC-REPORTING-DEFDOC-ONLY