72 lines
2.4 KiB
HTML
72 lines
2.4 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3O//DTD W3 HTML 2.0//EN">
|
|
<!Originally converted to HTML using LaTeX2HTML 95 (Thu Jan 19 1995) by Nikos Drakos (nikos@cbl.leeds.ac.uk), CBLU, University of Leeds >
|
|
<HEAD>
|
|
<TITLE> documentation (FUNCTION)</TITLE>
|
|
</HEAD>
|
|
<BODY>
|
|
<meta name="description" value=" documentation (FUNCTION)">
|
|
<meta name="keywords" value="lp">
|
|
<meta name="resource-type" value="document">
|
|
<meta name="distribution" value="global">
|
|
<P>
|
|
<BR> <HR>
|
|
<A HREF="node92.html"><IMG ALIGN=BOTTOM ALT="next" SRC="next_motif.gif"></A>
|
|
<A HREF="node72.html"><IMG ALIGN=BOTTOM ALT="up" SRC="up_motif.gif"></A>
|
|
<A HREF="node90.html"><IMG ALIGN=BOTTOM ALT="previous" SRC="previous_motif.gif"></A> <BR>
|
|
<A HREF="lp.html"><B>Contents</B></A>
|
|
<B> Next:</B>
|
|
<A HREF="node92.html"> eql (PREDICATE)</A>
|
|
<B>Up:</B>
|
|
<A HREF="node72.html"> Appendix: Selected Lisp </A>
|
|
<B> Previous:</B>
|
|
<A HREF="node90.html"> do (SPECIAL FORM)</A>
|
|
<BR> <HR> <P>
|
|
<H1> documentation (FUNCTION)</H1>
|
|
<P>
|
|
<b> Format:</b>
|
|
<tt> (documentation <func> <type> )</tt>
|
|
<P>
|
|
<b> Required arguments:</b>
|
|
2
|
|
<P>
|
|
<tt> <func> </tt> must evaluate to the name of a function
|
|
<tt> <type> </tt> must be function, variable, type, structure, or setf (see below)
|
|
<P>
|
|
This function is useful from the command line for a quick reminder of the format and usage of certain Lisp primitives. Both arguments are usually quoted symbols. See examples below.
|
|
<P>
|
|
<b> Examples:</b>
|
|
<P>
|
|
<BLOCKQUOTE>
|
|
<PRE>> (documentation 'documentation 'function)
|
|
"
|
|
Args: (symbol doc-type)
|
|
Returns the doc-string of DOC-TYPE for SYMBOL; NIL if none exists.
|
|
Possible doc-types are:
|
|
FUNCTION (special forms, macros, and functions)
|
|
VARIABLE (dynamic variables, including constants)
|
|
TYPE (types defined by DEFTYPE)
|
|
STRUCTURE (structures defined by DEFSTRUCT)
|
|
SETF (SETF methods defined by DEFSETF, DEFINE-SETF-METHOD, and
|
|
DEFINE-MODIFY-MACRO)
|
|
All built-in special forms, macros, functions, and variables have their
|
|
doc-strings."
|
|
|
|
> (documentation 'cdr 'function)
|
|
"
|
|
Args: (list)
|
|
Returns the cdr of LIST. Returns NIL if LIST is NIL."
|
|
|
|
> (documentation 'pi 'variable)
|
|
"
|
|
The floating-point number that is appropriately equal to the ratio of the
|
|
circumference of the circle to the diameter."
|
|
</PRE>
|
|
</BLOCKQUOTE>
|
|
<P>
|
|
<BR> <HR>
|
|
<P>
|
|
<ADDRESS>
|
|
<I>© Colin Allen & Maneesh Dhagat <BR>
|
|
March 2007 </I>
|
|
</ADDRESS>
|
|
</BODY>
|