Class Doclisp-Package

Part of:

package tinaa, class doclisp-assembly, class name-holder-mixin

Default initargs

:header → "Package":part-kind → "package"
:document? → T:part-type → 'PACKAGE

Direct Superclass

doclisp-assemblyA part with sub-parts.
name-holder-mixin

Slot

document?Initform:t, Initargs:document?; Reader:document?.
flag?Accessors:flag?.
headerInitform:, Initargs:header; Accessors:header.
instance
An instance of this part.
Initargs:instance; Reader:instance.
nameInitargs:name; Reader:name.
name-holderInitargs:name-holder; Reader:name-holder.
parentsInitargs:parents; Accessors:parents.
part-kindInitargs:part-kind; Reader:part-kind.
part-typeInitargs:part-type; Reader:part-type.
subpartsInitform:(make-container 'alist-container initial-element-fn (lambda nil (make-container 'alist-container))); Reader:subparts.
symbol-kindsInitform:(list internal external), Initargs:symbol-kinds; Accessors:symbol-kinds.
urlAccessors:url.

Direct Method

display-partOutput information about a part. Example modes are :subpart-list, :detail, :summary.
document-part-p
include-kind-in-index-pReturns true if part should include kind in it's index.
index-kindsReturns a list describing what indexes to generate for this part. This list is a list of lists of...
part-documentationReturns whatever documentation is available for part using the Common Lisp documentation function...
partname-listReturns a list of the names of the subparts of part of type 'part-kind'. Usually, these will be s...
span-class-for-part-nameReturns the class to be used when displaying the part's name.
start-grovel
subpart-kindsReturns a list of the kinds of the subparts of assembly. This is a list of instances of subpart-k...

Other Method

add-contents-link
build-documentation
build-index-links
build-indexes
doclisp-header
document-part-to-file
find-partReturns a existing part if it can be found.
finish-grovel
grovel-part
include-in-contents-p
make-root-pointing-url
maybe-show-documentation
name-holder
part-nameReturns the name of the part as a string
short-documentationReturns the first bit of the documentation for part. Change *short-documentation-length* to deter...
show-part-parentsGenerate HTML to show the parents of a part. Called for a part only when it actually has parents ...
url-for-partReturns the url for the part, creating it if necessary.