Class Doclisp-Variable

Part of:

package tinaa, class doclisp-constant, class doclisp-part

Default initargs

:header → #:part-kind → #
:part-type → #

Direct Superclass

doclisp-part

A part without pieces (a leaf).

Direct Subclass

doclisp-constant

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.
urlAccessors:url.

Direct Method

display-part

Output information about a part. Example modes are
:subpart-list, :detail, :summary.

documentation-exists-p
part-documentation

Returns whatever documentation is available for part using the Common Lisp documentation function...

Other Method

add-contents-link
build-index-links
build-indexes
depth-for-part
doclisp-header
document-part-p
document-part-to-file
finish-grovel
grovel-part
include-kind-in-index-p

Returns true if part should include kind in it's index.

index-kinds

Returns a list describing what indexes to generate for this part. This list is a list of lists of...

layout-engine-for-part
make-root-pointing-url
maybe-show-documentation
part-name

Returns the name of the part as a string

short-documentation

Returns the first bit of the documentation for part.
Change short-documentation-length to deter...

show-part-parents

Generate HTML to show the parents of a part. Called for a part only when it actually has parents ...

span-class-for-part-name

Returns the class to be used when displaying the part's name.

start-grovel
subpart-kinds

Returns a list of the kinds of the subparts of assembly.
This is a list of instances of subpart-k...

url-for-part

Returns the url for the part, creating it if necessary.