Class Doclisp-File

Part of:

package tinaa, class basic-doclisp-part

Default initargs

:header → "File":part-kind → "file"
:document? → T:part-type → 'FILE

Direct Superclass

basic-doclisp-part

Slot

document?Initform:t, Initargs:document?; Reader:document?.
enough-filenameInitargs:enough-filename; Reader:enough-filename.
filenameInitargs:filename; Reader:filename.
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.
systemInitargs:system; Reader:system.
urlAccessors:url.

Direct Method

display-partOutput information about a part. Example modes are :subpart-list, :detail, :summary.
part-nameReturns the name of the part as a string

Other Method

add-contents-link
build-index-links
build-indexes
doclisp-header
document-part-p
document-part-to-file
finish-grovel
grovel-part
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...
make-root-pointing-url
maybe-show-documentation
part-documentationReturns whatever documentation is available for part using the Common Lisp documentation function...
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 ...
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...
url-for-partReturns the url for the part, creating it if necessary.