Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]
Return CLOS slot DEFINITION’s allocation type.
Extract and return documentation information for ASDF SYSTEM-NAME.
The documentation information is returned in a REPORT structure, which see.
SYSTEM-NAME is an ASDF system designator. The following keyword parameters
allow to specify or override some bits of information.
- INTROSPECTION-LEVEL: how hard to introspect the Lisp environment. At level 1
(the default), scan only the symbols from domestic packages. At level 2,
scan all accessible symbols in the Lisp environment. Some additional
information may be discovered in the process, at the expense of a much
higher computation time.
- LIBRARY-NAME: name of the library being documented. Defaults to the system
name.
- TAGLINE: small text to be used as the manual’s subtitle, or NIL.
Defaults to the system long name or description.
- LIBRARY-VERSION: version information, or NIL.
Defaults to the system version.
- CONTACT: contact information, or NIL. The default value is computed from the
system maintainer(s), author(s), and mailto information. Accepts a contact
string, or a list of such. See ‘parse-contact-string’ for more information.
- COPYRIGHT-YEARS: copyright years information or NIL. Defaults to the current
year.
- LICENSE: license information. Defaults to NIL. Also accepts :mit, :boost,
:bsd, :gpl, :lgpl, and :ms-pl.
- INTRODUCTION: introduction chapter contents in Texinfo format.
Defaults to NIL.
- CONCLUSION: conclusion chapter contents in Texinfo format.
Defaults to NIL.
Return system DEFINITION’s bug tracker, or NIL.
Return generic function DEFINITION’s method combination options.
Return T if DEFINITION is a component definition.
Return KEY’s value in the current Declt configuration.
Set KEY to VALUE in the current Declt configuration.
Generate a reference manual for ASDF SYSTEM-NAME.
The reference manual is currently generated in Texinfo format.
For a description of SYSTEM-NAME, INTROSPECTION-LEVEL, LIBRARY-NAME, TAGLINE,
LIBRARY-VERSION, CONTACT, COPYRIGHT-YEARS, LICENSE, INTRODUCTION, and
CONCLUSION, see ‘assess’.
For a description of LOCATIONS, DEFAULT-VALUES, FOREIGN-DEFINITIONS, and
DECLT-NOTICE, see ‘make-context’.
The following keyword parameters are also available.
- OUTPUT-DIRECTORY: output directory for the generated reference manual.
Defaults to the current directory.
- FILE-NAME: base name for the generated reference manual, sans extension.
Defaults to the system name.
- INFO-NAME: base name for the subsequent Info file, sans extension (this
name appears in the Texinfo file). Defaults to FILE-NAME.
- INFO-CATEGORY: category under which to install the Info file (technically,
this provides the value for Texinfo’s @dircategory command).
Defaults to "Common Lisp".
Return component DEFINITION’s version string.
Return component DEFINITION’s description.
Return CLOS classoid mixin DEFINITION’s direct default initargs.
Return file DEFINITION’s file extension, if any.
Return T if DEFINITION is a file definition.
Return the first finding of OBJECT in LIST, or NIL.
Each item in LIST is TESTed with EQ by default. TEST is performed on the item
itself by default, or on the result of applying KEY to it. Optionally, only
items satisfying PRE-TEST are considered.
Return system DEFINITION’s homepage, or NIL.
Return short combination DEFINITION’s :identity-with-one-argument option.
Return component DEFINITION’s if-feature.
Return CLOS slot DEFINITION’s initargs.
Return CLOS slot DEFINITION’s initform.
Return system DEFINITION’s license name, or NIL.
Return T if DEFINITION is a Lisp file definition.
Return component DEFINITION’s long description.
Return system DEFINITION’s long name, or NIL.
Return system DEFINITION’s mailto, or NIL.
Short for "mapconcat": non destructive version of MAPCAN. That is, concatenate the results with APPEND rather than NCONC.
Return T if DEFINITION is a method definition.
Return T if DEFINITION is a module definition.
Add NICKNAME (:DECLT by default) to the :NET.DIDIERVERNA.DECLT package.
Return the list of nicknames for PACKAGE-DEFINITION.
Return T if OBJECT is a non-empty string.
Return T if DEFINITION is a package definition.
Return T is DEFINITION is public.
A definition is public when the symbol naming it has a home package,
and is exported from it.
Return method DEFINITION’s method qualifiers.
Return T if DEFINITION is a reader method definition.
Return a copy of LIST from which only OBJECT is retained.
Each item in LIST is TESTed with EQ by default. TEST is performed on the item
itself by default, or on the result of applying KEY to it. Optionally, only
items satisfying PRE-TEST are considered.
Return T if DEFINITION is a short expander definition.
Return system DEFINITION’s source control, or NIL.
Return T if DEFINITION is a symbol definition.
Return T if DEFINITION is a system definition.
Return the current version of Declt.
TYPE can be one of :number, :short or :long.
A version number is computed as major*10000 + minor*100 + patchlevel, leaving
two digits for each level. Alpha, beta and rc status are ignored in version
numbers.
A short version is something like 1.3{a,b,rc}4, or 1.3.4 for patchlevel.
Alpha, beta or rc levels start at 1. Patchlevels start at 0 but are ignored
in the output, so that 1.3.0 appears as just 1.3.
A long version is something like
1.3 {alpha,beta,release candidate,patchlevel} 4 "James T. Kirk". As for
the short version, a patchlevel of 0 is ignored in the output.
Return T if DEFINITION is a writer method definition.
Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]