Structure summary | |
---|---|
meta-descriptor |
Function summary | |
---|---|
belongs-p | desc package-name |
cache-descriptor | descriptor index src-file dest-dir prefix output-type |
cache-meta-descriptors | |
clear-cache | |
copy-meta-descriptor | meta-descriptor |
initialise-cache | o-dir o-type path-prefix &rest filenames |
lookup-meta-descriptor | desc &optional desc-type package |
lookup-meta-descriptor-anchor | desc &optional desc-type package |
lookup-meta-descriptor-href | desc &optional desc-type package relative |
make-meta-descriptor | &key desc (file "") (anchor "") (index -1) |
meta-descriptor-anchor | meta-descriptor |
meta-descriptor-desc | meta-descriptor |
meta-descriptor-file | meta-descriptor |
meta-descriptor-href | meta-desc &optional relative |
meta-descriptor-index | meta-descriptor |
meta-descriptor-p | object |
Holds a symbol-descriptor object with enough additional information to construct indexes for cross referencing and hyper link creation.
Returns and (with setf) changes the index of the specified meta-descriptor
Returns and (with setf) changes the anchor of the specified meta-descriptor
Returns and (with setf) changes the file of the specified meta-descriptor
Returns a newly created meta-descriptor.
Returns T if the specified symbol-descriptor belongs to the named package.
The package search will be case insensitive.
Returns the meta href href that links the specified descriptor.
Returns the meta-descriptor structure if any that holds a symbol-descriptor that is eq to desc if desc if a symbol-descriptor object. If desc is a string that names a descriptor then the meta-descriptor that holds a symbol-descriptor with name desc and type desc-type is returned.
If package is specified then the returned meta-descriptor must be located in the specified package. desc-type, if given can be a symbol specifying a class type or a string that should be equal to the desc-type slot of the symbol descriptor holds by the meta descriptor candidate.
Returns the meta anchor if any for the specified descriptor or named descriptor if desc is a string. (see: lookup-meta-descriptor )
Returns the meta href if any that links the specified descriptor or named descriptor if desc is a string. If relative is given, it must be a string designator for a filename. The returned href will be computed relatively to this filename. (see: lookup-meta-descriptor ).