Common Lisp Package: COM.INFORMATIMAGO.LISPDOC

Automatically generate documentation for properly documented symbols exported from packages. This is tool automatically generates documentation for Common Lisp code based on symbols that exported from packages and properly documented. This code was written for OpenMCL <http://openmcl.clozure.com> License: LLGPL Copyright Pascal J. Bourguignon 2012 - 2012 Copyright (C) 2003 Sven Van Caekenberghe. You are granted the rights to distribute and use this software as governed by the terms of the Lisp Lesser GNU Public License <http://opensource.franz.com/preamble.html> also known as the LLGPL.

README:

FUNCTION

Public

LISPDOC (PACKAGES)

Generate a lispdoc sexp documenting the exported symbols of each package

LISPDOC-HTML (DIRECTORY PACKAGES &KEY (TITLE Packages))

Generate HTML documentation in a file per package in directory for the exported symbols of each package

Private

CLASS-PRECEDENCE-LIST (CLASS-NAME)

CLASS-NAME: A class name. RETURN: The class precedence list.

CLASS-SLOT-INITARGS (CLASS-NAME)

CLASS-NAME: A class name. RETURN: The initargs of the class slots.

CLASSDOC-INITARGS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CLASSDOC-KIND (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CLASSDOC-PRECEDENCE-LIST (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CLASSDOC-STRING (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

CLASSDOC-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

DOC-KIND (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

DOC-STRING (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

DOC-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

FUNCTION-LAMBDA-LIST (FUNAME)

FUNAME: A function name. RETURN: The function lambda list.

FUNDOC-KIND (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

FUNDOC-LAMBDA-LIST (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

FUNDOC-STRING (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

FUNDOC-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

GENERATE-FLAT-SYMBOL-INDEX (SYMS &OPTIONAL (FILENAME flatsymindex))

RETURN: A list of (initial filename)

GENERATE-PERMUTED-SYMBOL-INDEX (SYMS &OPTIONAL (FILENAME permsymindex))

RETURN: A list of (initial filename)

LISPDOC-PACKAGE (PACKAGE)

RETURN: packdoc structure for the package.

LISPDOC-SYMBOL (SYMBOL)

RETURN: A list of doc structures for the SYMBOL.

PACKDOC-EXTERNAL-SYMBOL-DOCS (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

PACKDOC-KIND (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

PACKDOC-NICKNAMES (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

PACKDOC-STRING (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

PACKDOC-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

REPLACE-URLS (TEXT)

Search all the urls in the text, and replace them with an A tag.

TREE-CHILDREN (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

TREE-NODE (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

TREE-PACKAGE (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

TREE-PARENT (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

TREE-PATH (TREE)

RETURN: The path from TREE to the root.

VARDOC-INITIAL-VALUE (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

VARDOC-KIND (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

VARDOC-STRING (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

VARDOC-SYMBOL (INSTANCE)

@arg[extid]{A @class{extid}} @return[sytemid]{puri:uri or nil} Returns the System ID part of this External ID.

Undocumented

SETFCLASSDOC-INITARGS (NEW-VALUE INSTANCE)

SETFCLASSDOC-KIND (NEW-VALUE INSTANCE)

CLASSDOC-P (OBJECT)

SETFCLASSDOC-PRECEDENCE-LIST (NEW-VALUE INSTANCE)

SETFCLASSDOC-STRING (NEW-VALUE INSTANCE)

SETFCLASSDOC-SYMBOL (NEW-VALUE INSTANCE)

COLLECT-ALL-SYMBOLS (PACKDOCS)

COPY-CLASSDOC (INSTANCE)

COPY-DOC (INSTANCE)

COPY-FUNDOC (INSTANCE)

COPY-PACKDOC (INSTANCE)

COPY-VARDOC (INSTANCE)

CREATE-STYLE-SHEET

SETFDOC-KIND (NEW-VALUE INSTANCE)

DOC-NAME (DOC)

DOC-P (OBJECT)

SETFDOC-STRING (NEW-VALUE INSTANCE)

SETFDOC-SYMBOL (NEW-VALUE INSTANCE)

DOC-TITLE (NAME ARGLIST KIND)

SETFFUNDOC-KIND (NEW-VALUE INSTANCE)

SETFFUNDOC-LAMBDA-LIST (NEW-VALUE INSTANCE)

FUNDOC-P (OBJECT)

SETFFUNDOC-STRING (NEW-VALUE INSTANCE)

SETFFUNDOC-SYMBOL (NEW-VALUE INSTANCE)

GENERATE-FLAT-PACKAGE-INDEX (PAGES &OPTIONAL (FILENAME flatindex))

GENERATE-HIERARCHICAL-PACKAGE-INDEX (TREE &OPTIONAL (FILENAME hierindex))

GENERATE-SYMBOL-INDEX (FLAT-INDICES PERMUTED-INDICES SYMBOL-COUNT &OPTIONAL (FILENAME symindex))

HAS-MEANING (SYMBOL)

INITIAL (OBJECT)

MAKE-CLASSDOC (&KEY ((SYMBOL DUM228) NIL) ((KIND DUM229) NIL) ((STRING DUM230) NIL) ((PRECEDENCE-LIST DUM231) NIL) ((INITARGS DUM232) NIL))

MAKE-DOC (&KEY ((SYMBOL DUM60) NIL) ((KIND DUM61) NIL) ((STRING DUM62) NIL))

MAKE-FUNDOC (&KEY ((SYMBOL DUM186) NIL) ((KIND DUM187) NIL) ((STRING DUM188) NIL) ((LAMBDA-LIST DUM189) NIL))

MAKE-INDEX-TREE (PACKAGE-NAMES)

MAKE-PACKDOC (&KEY ((SYMBOL DUM100) NIL) ((KIND DUM101) NIL) ((STRING DUM102) NIL) ((NICKNAMES DUM103) NIL) ((EXTERNAL-SYMBOL-DOCS DUM104) NIL))

MAKE-TREE (&KEY ((PARENT DUM463) NIL) ((NODE DUM464) NIL) ((PACKAGE DUM465) NIL) ((CHILDREN DUM466) 'NIL))

MAKE-URL (PAGE)

MAKE-VARDOC (&KEY ((SYMBOL DUM144) NIL) ((KIND DUM145) NIL) ((STRING DUM146) NIL) ((INITIAL-VALUE DUM147) NIL))

MAP (RESULT-TYPE FUNCTION FIRST-SEQUENCE &REST MORE-SEQUENCES)

PACKAGE-NAVIGATION-MENU (CURRENT-PAGE &OPTIONAL (*NAVIGATION* *NAVIGATION*))

PACKAGE-PATH (PACKAGE)

SETFPACKDOC-EXTERNAL-SYMBOL-DOCS (NEW-VALUE INSTANCE)

SETFPACKDOC-KIND (NEW-VALUE INSTANCE)

SETFPACKDOC-NICKNAMES (NEW-VALUE INSTANCE)

PACKDOC-P (OBJECT)

SETFPACKDOC-STRING (NEW-VALUE INSTANCE)

SETFPACKDOC-SYMBOL (NEW-VALUE INSTANCE)

PJB-DOCSTRING (DOCSTRING)

PJB-HEAD (TITLE)

REPORT-FILE (PATH)

RIGHT-CASE (SEXP)

STYLE-SHEET

TREE-ADD-NODE-AT-PATH (TREE PATH PNAME)

SETFTREE-CHILDREN (NEW-VALUE INSTANCE)

TREE-CHILDREN-NAMED (TREE NODE)

TREE-COPY (INSTANCE)

SETFTREE-NODE (NEW-VALUE INSTANCE)

TREE-NODE-AT-PATH (TREE PATH)

TREE-P (OBJECT)

SETFTREE-PACKAGE (NEW-VALUE INSTANCE)

SETFTREE-PARENT (NEW-VALUE INSTANCE)

SETFVARDOC-INITIAL-VALUE (NEW-VALUE INSTANCE)

SETFVARDOC-KIND (NEW-VALUE INSTANCE)

VARDOC-P (OBJECT)

SETFVARDOC-STRING (NEW-VALUE INSTANCE)

SETFVARDOC-SYMBOL (NEW-VALUE INSTANCE)

MACRO

Private

APPENDF (PLACE &REST ARGS &ENVIRONMENT ENV)

Append onto list

GENERIC-FUNCTION

Public

RENDER-HTML (DOC)

Generate the HTML representation of the DOC structure.

VARIABLE

Private

Undocumented

*INDEX-TREE*

*NAVIGATION*

*PAGES*

CLASS

Private

Undocumented

CLASSDOC

DOC

FUNDOC

PACKDOC

TREE

VARDOC