226 lines
24 KiB
HTML
226 lines
24 KiB
HTML
|
<!-- Common Lisp HyperSpec (TM), version 7.0 generated by Kent M. Pitman on Mon, 11-Apr-2005 2:31am EDT -->
|
||
|
|
<HTML>
|
||
|
|
<HEAD>
|
||
|
|
<TITLE>CLHS: Standard Generic Function DOCUMENTATION...</TITLE>
|
||
|
|
<LINK HREF="../Data/clhs.css" REL="stylesheet" TYPE="text/css" />
|
||
|
|
<META HTTP-EQUIV="Author" CONTENT="Kent M. Pitman">
|
||
|
|
<META HTTP-EQUIV="Organization" CONTENT="LispWorks Ltd.">
|
||
|
|
<LINK REL=TOP HREF="../Front/index.htm">
|
||
|
|
<LINK REL=COPYRIGHT HREF="../Front/Help.htm#Legal">
|
||
|
|
<LINK REL=DISCLAIMER HREF="../Front/Help.htm#Disclaimer">
|
||
|
|
<LINK REL=PREV HREF="f_disass.htm">
|
||
|
|
<LINK REL=UP HREF="c_enviro.htm">
|
||
|
|
<LINK REL=NEXT HREF="f_room.htm">
|
||
|
|
</HEAD>
|
||
|
|
<BODY>
|
||
|
|
<H1><A REV=MADE HREF="http://www.lispworks.com/"><IMG WIDTH=80 HEIGHT=65 ALT="[LISPWORKS]" SRC="../Graphics/LWSmall.gif" ALIGN=Bottom></A><A REL=TOP HREF="../Front/index.htm"><IMG WIDTH=237 HEIGHT=65 ALT="[Common Lisp HyperSpec (TM)]" SRC="../Graphics/CLHS_Sm.gif" ALIGN=Bottom></A> <A REL=PREV HREF="f_disass.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Previous]" SRC="../Graphics/Prev.gif" ALIGN=Bottom></A><A REL=UP HREF="c_enviro.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Up]" SRC="../Graphics/Up.gif" ALIGN=Bottom></A><A REL=NEXT HREF="f_room.htm"><IMG WIDTH=40 HEIGHT=40 ALT="[Next]" SRC="../Graphics/Next.gif" ALIGN=Bottom></A></H1>
|
||
|
|
|
||
|
|
<HR>
|
||
|
|
|
||
|
|
<A NAME="documentation"><A NAME="OPsetf_documentationCP"><I>Standard Generic Function</I> <B>DOCUMENTATION, (SETF DOCUMENTATION)</B></A></A> <P>
|
||
|
|
<P><B>Syntax:</B><P>
|
||
|
|
<P>
|
||
|
|
|
||
|
|
<B>documentation</B> <I>x doc-type</I> => <I>documentation</I><P>
|
||
|
|
<P>
|
||
|
|
|
||
|
|
<B>(setf documentation)</B> <I>new-value x doc-type</I> => <I>new-value</I><P>
|
||
|
|
<P>
|
||
|
|
<P><B>Argument Precedence Order:</B><P>
|
||
|
|
<P>
|
||
|
|
<I>doc-type</I>, <I>object</I> <P>
|
||
|
|
<P><B>Method Signatures:</B><P>
|
||
|
|
<P>
|
||
|
|
<P>
|
||
|
|
<P>
|
||
|
|
<B>Functions, Macros, and Special Forms:</B><P>
|
||
|
|
|
||
|
|
<B>documentation</B> <I></I>(<I>x</I><B> <A REL=DEFINITION HREF="t_fn.htm#function">function</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_t.htm#t">t</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="t"></A><P>
|
||
|
|
|
||
|
|
<B>documentation</B> <I></I>(<I>x</I><B> <A REL=DEFINITION HREF="t_fn.htm#function">function</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_fn.htm#function">function</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="function"></A><P>
|
||
|
|
|
||
|
|
<B>documentation</B> <I></I>(<I>x</I><B> <A REL=DEFINITION HREF="t_list.htm#list">list</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_fn.htm#function">function</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="function"></A><P>
|
||
|
|
|
||
|
|
<B>documentation</B> <I></I>(<I>x</I><B> <A REL=DEFINITION HREF="t_list.htm#list">list</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="#compiler-macro">compiler-macro</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="compiler-macro"></A><P>
|
||
|
|
|
||
|
|
<B>documentation</B> <I></I>(<I>x</I><B> <A REL=DEFINITION HREF="t_symbol.htm#symbol">symbol</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_fn.htm#function">function</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="function"></A><P>
|
||
|
|
|
||
|
|
<B>documentation</B> <I></I>(<I>x</I><B> <A REL=DEFINITION HREF="t_symbol.htm#symbol">symbol</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="#compiler-macro">compiler-macro</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="compiler-macro"></A><P>
|
||
|
|
|
||
|
|
<B>documentation</B> <I></I>(<I>x</I><B> <A REL=DEFINITION HREF="t_symbol.htm#symbol">symbol</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_setf.htm#setf">setf</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="setf"></A><P>
|
||
|
|
<P>
|
||
|
|
|
||
|
|
<B>(setf documentation)</B> <I>new-value </I>(<I>x</I><B> <A REL=DEFINITION HREF="t_fn.htm#function">function</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_t.htm#t">t</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="t"></A><P>
|
||
|
|
|
||
|
|
<B>(setf documentation)</B> <I>new-value </I>(<I>x</I><B> <A REL=DEFINITION HREF="t_fn.htm#function">function</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_fn.htm#function">function</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="function"></A><P>
|
||
|
|
|
||
|
|
<B>(setf documentation)</B> <I>new-value </I>(<I>x</I><B> <A REL=DEFINITION HREF="t_list.htm#list">list</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_fn.htm#function">function</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="function"></A><P>
|
||
|
|
|
||
|
|
<B>(setf documentation)</B> <I>new-value </I>(<I>x</I><B> <A REL=DEFINITION HREF="t_list.htm#list">list</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="#compiler-macro">compiler-macro</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="compiler-macro"></A><P>
|
||
|
|
|
||
|
|
<B>(setf documentation)</B> <I>new-value </I>(<I>x</I><B> <A REL=DEFINITION HREF="t_symbol.htm#symbol">symbol</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_fn.htm#function">function</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="function"></A><P>
|
||
|
|
|
||
|
|
<B>(setf documentation)</B> <I>new-value </I>(<I>x</I><B> <A REL=DEFINITION HREF="t_symbol.htm#symbol">symbol</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="#compiler-macro">compiler-macro</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="compiler-macro"></A><P>
|
||
|
|
|
||
|
|
<B>(setf documentation)</B> <I>new-value </I>(<I>x</I><B> <A REL=DEFINITION HREF="t_symbol.htm#symbol">symbol</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_setf.htm#setf">setf</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="setf"></A><P>
|
||
|
|
<P>
|
||
|
|
<P>
|
||
|
|
<B>Method Combinations:</B><P>
|
||
|
|
|
||
|
|
<B>documentation</B> <I></I>(<I>x</I><B> <A REL=DEFINITION HREF="t_meth_1.htm#method-combination">method-combination</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_t.htm#t">t</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="t"></A><P>
|
||
|
|
|
||
|
|
<B>documentation</B> <I></I>(<I>x</I><B> <A REL=DEFINITION HREF="t_meth_1.htm#method-combination">method-combination</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_method.htm#method-combination">method-combination</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="method-combination"></A><P>
|
||
|
|
|
||
|
|
<B>documentation</B> <I></I>(<I>x</I><B> <A REL=DEFINITION HREF="t_symbol.htm#symbol">symbol</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_method.htm#method-combination">method-combination</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="method-combination"></A><P>
|
||
|
|
<P>
|
||
|
|
|
||
|
|
<B>(setf documentation)</B> <I>new-value </I>(<I>x</I><B> <A REL=DEFINITION HREF="t_meth_1.htm#method-combination">method-combination</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_t.htm#t">t</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="t"></A><P>
|
||
|
|
|
||
|
|
<B>(setf documentation)</B> <I>new-value </I>(<I>x</I><B> <A REL=DEFINITION HREF="t_meth_1.htm#method-combination">method-combination</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_method.htm#method-combination">method-combination</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="method-combination"></A><P>
|
||
|
|
|
||
|
|
<B>(setf documentation)</B> <I>new-value </I>(<I>x</I><B> <A REL=DEFINITION HREF="t_symbol.htm#symbol">symbol</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_method.htm#method-combination">method-combination</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="method-combination"></A><P>
|
||
|
|
<P>
|
||
|
|
<P>
|
||
|
|
<B>Methods:</B><P>
|
||
|
|
|
||
|
|
<B>documentation</B> <I></I>(<I>x</I><B> <A REL=DEFINITION HREF="t_std_me.htm#standard-method">standard-method</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_t.htm#t">t</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="t"></A><P>
|
||
|
|
<P>
|
||
|
|
|
||
|
|
<B>(setf documentation)</B> <I>new-value </I>(<I>x</I><B> <A REL=DEFINITION HREF="t_std_me.htm#standard-method">standard-method</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_t.htm#t">t</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="t"></A><P>
|
||
|
|
<P>
|
||
|
|
<P>
|
||
|
|
<B>Packages:</B><P>
|
||
|
|
|
||
|
|
<B>documentation</B> <I></I>(<I>x</I><B> <A REL=DEFINITION HREF="t_pkg.htm#package">package</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_t.htm#t">t</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="t"></A><P>
|
||
|
|
<P>
|
||
|
|
|
||
|
|
<B>(setf documentation)</B> <I>new-value </I>(<I>x</I><B> <A REL=DEFINITION HREF="t_pkg.htm#package">package</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_t.htm#t">t</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="t"></A><P>
|
||
|
|
<P>
|
||
|
|
<P>
|
||
|
|
<B>Types, Classes, and Structure Names:</B><P>
|
||
|
|
|
||
|
|
<B>documentation</B> <I></I>(<I>x</I><B> <A REL=DEFINITION HREF="t_std_cl.htm#standard-class">standard-class</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_t.htm#t">t</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="t"></A><P>
|
||
|
|
|
||
|
|
<B>documentation</B> <I></I>(<I>x</I><B> <A REL=DEFINITION HREF="t_std_cl.htm#standard-class">standard-class</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_type.htm#type">type</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="type"></A><P>
|
||
|
|
|
||
|
|
<B>documentation</B> <I></I>(<I>x</I><B> <A REL=DEFINITION HREF="t_stu_cl.htm#structure-class">structure-class</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_t.htm#t">t</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="t"></A><P>
|
||
|
|
|
||
|
|
<B>documentation</B> <I></I>(<I>x</I><B> <A REL=DEFINITION HREF="t_stu_cl.htm#structure-class">structure-class</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_type.htm#type">type</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="type"></A><P>
|
||
|
|
|
||
|
|
<B>documentation</B> <I></I>(<I>x</I><B> <A REL=DEFINITION HREF="t_symbol.htm#symbol">symbol</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_type.htm#type">type</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="type"></A><P>
|
||
|
|
|
||
|
|
<B>documentation</B> <I></I>(<I>x</I><B> <A REL=DEFINITION HREF="t_symbol.htm#symbol">symbol</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="#structure">structure</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="structure"></A><P>
|
||
|
|
<P>
|
||
|
|
|
||
|
|
<B>(setf documentation)</B> <I>new-value </I>(<I>x</I><B> <A REL=DEFINITION HREF="t_std_cl.htm#standard-class">standard-class</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_t.htm#t">t</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="t"></A><P>
|
||
|
|
|
||
|
|
<B>(setf documentation)</B> <I>new-value </I>(<I>x</I><B> <A REL=DEFINITION HREF="t_std_cl.htm#standard-class">standard-class</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_type.htm#type">type</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="type"></A><P>
|
||
|
|
|
||
|
|
<B>(setf documentation)</B> <I>new-value </I>(<I>x</I><B> <A REL=DEFINITION HREF="t_stu_cl.htm#structure-class">structure-class</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_t.htm#t">t</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="t"></A><P>
|
||
|
|
|
||
|
|
<B>(setf documentation)</B> <I>new-value </I>(<I>x</I><B> <A REL=DEFINITION HREF="t_stu_cl.htm#structure-class">structure-class</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_type.htm#type">type</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="type"></A><P>
|
||
|
|
|
||
|
|
<B>(setf documentation)</B> <I>new-value </I>(<I>x</I><B> <A REL=DEFINITION HREF="t_symbol.htm#symbol">symbol</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="a_type.htm#type">type</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="type"></A><P>
|
||
|
|
|
||
|
|
<B>(setf documentation)</B> <I>new-value </I>(<I>x</I><B> <A REL=DEFINITION HREF="t_symbol.htm#symbol">symbol</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="#structure">structure</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="structure"></A><P>
|
||
|
|
<P>
|
||
|
|
<P>
|
||
|
|
<B>Variables:</B><P>
|
||
|
|
|
||
|
|
<B>documentation</B> <I></I>(<I>x</I><B> <A REL=DEFINITION HREF="t_symbol.htm#symbol">symbol</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="#variable">variable</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="variable"></A><P>
|
||
|
|
<P>
|
||
|
|
|
||
|
|
<B>(setf documentation)</B> <I>new-value </I>(<I>x</I><B> <A REL=DEFINITION HREF="t_symbol.htm#symbol">symbol</A></B><I></I>)<I> </I>(<I>doc-type</I><B> </B><TT>(</TT><B><A REL=DEFINITION HREF="t_eql.htm#eql">eql</A></B><TT> '</TT><B><A REL=DEFINITION HREF="#variable">variable</A></B><TT>)</TT><B></B><I></I>)<I></I><P>
|
||
|
|
<A NAME="variable"></A><P>
|
||
|
|
<P>
|
||
|
|
<P>
|
||
|
|
<P><B>Arguments and Values:</B><P>
|
||
|
|
<P>
|
||
|
|
<I>x</I>---an <A REL=DEFINITION HREF="26_glo_o.htm#object"><I>object</I></A>. <P>
|
||
|
|
<I>doc-type</I>---a <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A>. <P>
|
||
|
|
<I>documentation</I>---a <A REL=DEFINITION HREF="26_glo_s.htm#string"><I>string</I></A>, or <A REL=DEFINITION HREF="a_nil.htm#nil"><B>nil</B></A>. <P>
|
||
|
|
<I>new-value</I>---a <A REL=DEFINITION HREF="26_glo_s.htm#string"><I>string</I></A>. <P>
|
||
|
|
<P><B>Description:</B><P>
|
||
|
|
<P>
|
||
|
|
The <A REL=DEFINITION HREF="26_glo_g.htm#generic_function"><I>generic function</I></A> <A REL=DEFINITION HREF="#documentation"><B>documentation</B></A> returns the <A REL=DEFINITION HREF="26_glo_d.htm#documentation_string"><I>documentation string</I></A> associated with the given <A REL=DEFINITION HREF="26_glo_o.htm#object"><I>object</I></A> if it is available; otherwise it returns <A REL=DEFINITION HREF="a_nil.htm#nil"><B>nil</B></A>. <P>
|
||
|
|
The <A REL=DEFINITION HREF="26_glo_g.htm#generic_function"><I>generic function</I></A> <TT>(setf documentation)</TT> updates the <A REL=DEFINITION HREF="26_glo_d.htm#documentation_string"><I>documentation string</I></A> associated with <I>x</I> to <I>new-value</I>. If <I>x</I> is a <A REL=DEFINITION HREF="26_glo_l.htm#list"><I>list</I></A>, it must be of the form <TT>(setf </TT><I>symbol</I><TT>)</TT>. <P>
|
||
|
|
<A REL=DEFINITION HREF="26_glo_d.htm#documentation_string"><I>Documentation strings</I></A> are made available for debugging purposes. <A REL=DEFINITION HREF="26_glo_c.htm#conforming_program"><I>Conforming programs</I></A> are permitted to use <A REL=DEFINITION HREF="26_glo_d.htm#documentation_string"><I>documentation strings</I></A> when they are present, but should not depend for their correct behavior on the presence of those <A REL=DEFINITION HREF="26_glo_d.htm#documentation_string"><I>documentation strings</I></A>. An <A REL=DEFINITION HREF="26_glo_i.htm#implementation"><I>implementation</I></A> is permitted to discard <A REL=DEFINITION HREF="26_glo_d.htm#documentation_string"><I>documentation strings</I></A> at any time for <A REL=DEFINITION HREF="26_glo_i.htm#implementation-defined"><I>implementation-defined</I></A> reasons. <P>
|
||
|
|
The nature of the <A REL=DEFINITION HREF="26_glo_d.htm#documentation_string"><I>documentation string</I></A> returned depends on the <I>doc-type</I>, as follows: <P>
|
||
|
|
<P><DL><P>
|
||
|
|
<DT><A REL=DEFINITION HREF="#compiler-macro"><B>compiler-macro</B></A> <P><DD>
|
||
|
|
Returns the <A REL=DEFINITION HREF="26_glo_d.htm#documentation_string"><I>documentation string</I></A> of the <A REL=DEFINITION HREF="26_glo_c.htm#compiler_macro"><I>compiler macro</I></A> whose <A REL=DEFINITION HREF="26_glo_n.htm#name"><I>name</I></A> is the <A REL=DEFINITION HREF="26_glo_f.htm#function_name"><I>function name</I></A> <I>x</I>. <P>
|
||
|
|
<DT><A REL=DEFINITION HREF="#function"><B>function</B></A> <P><DD>
|
||
|
|
If <I>x</I> is a <A REL=DEFINITION HREF="26_glo_f.htm#function_name"><I>function name</I></A>, returns the <A REL=DEFINITION HREF="26_glo_d.htm#documentation_string"><I>documentation string</I></A> of the <A REL=DEFINITION HREF="26_glo_f.htm#function"><I>function</I></A>, <A REL=DEFINITION HREF="26_glo_m.htm#macro"><I>macro</I></A>, or <A REL=DEFINITION HREF="26_glo_s.htm#special_operator"><I>special operator</I></A> whose <A REL=DEFINITION HREF="26_glo_n.htm#name"><I>name</I></A> is <I>x</I>. <P>
|
||
|
|
If <I>x</I> is a <A REL=DEFINITION HREF="26_glo_f.htm#function"><I>function</I></A>, returns the <A REL=DEFINITION HREF="26_glo_d.htm#documentation_string"><I>documentation string</I></A> associated with <I>x</I>. <P>
|
||
|
|
<DT><A REL=DEFINITION HREF="#method-combination"><B>method-combination</B></A> <P><DD>
|
||
|
|
If <I>x</I> is a <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A>, returns the <A REL=DEFINITION HREF="26_glo_d.htm#documentation_string"><I>documentation string</I></A> of the <A REL=DEFINITION HREF="26_glo_m.htm#method_combination"><I>method combination</I></A> whose <A REL=DEFINITION HREF="26_glo_n.htm#name"><I>name</I></A> is <I>x</I>. <P>
|
||
|
|
If <I>x</I> is a <A REL=DEFINITION HREF="26_glo_m.htm#method_combination"><I>method combination</I></A>, returns the <A REL=DEFINITION HREF="26_glo_d.htm#documentation_string"><I>documentation string</I></A> associated with <I>x</I>. <P>
|
||
|
|
<DT><A REL=DEFINITION HREF="#setf"><B>setf</B></A> <P><DD>
|
||
|
|
Returns the <A REL=DEFINITION HREF="26_glo_d.htm#documentation_string"><I>documentation string</I></A> of the <A REL=DEFINITION HREF="26_glo_s.htm#setf_expander"><I>setf expander</I></A> whose <A REL=DEFINITION HREF="26_glo_n.htm#name"><I>name</I></A> is the <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A> <I>x</I>. <P>
|
||
|
|
<DT><A REL=DEFINITION HREF="#structure"><B>structure</B></A> <P><DD>
|
||
|
|
Returns the <A REL=DEFINITION HREF="26_glo_d.htm#documentation_string"><I>documentation string</I></A> associated with the <A REL=DEFINITION HREF="26_glo_s.htm#structure_name"><I>structure name</I></A> <I>x</I>. <P>
|
||
|
|
<DT><A REL=DEFINITION HREF="#t"><B>t</B></A> <P><DD>
|
||
|
|
Returns a <A REL=DEFINITION HREF="26_glo_d.htm#documentation_string"><I>documentation string</I></A> specialized on the <A REL=DEFINITION HREF="26_glo_c.htm#class"><I>class</I></A> of the argument <I>x</I> itself. For example, if <I>x</I> is a <A REL=DEFINITION HREF="26_glo_f.htm#function"><I>function</I></A>, the <A REL=DEFINITION HREF="26_glo_d.htm#documentation_string"><I>documentation string</I></A> associated with the <A REL=DEFINITION HREF="26_glo_f.htm#function"><I>function</I></A> <I>x</I> is returned. <P>
|
||
|
|
<DT><A REL=DEFINITION HREF="#type"><B>type</B></A> <P><DD>
|
||
|
|
If <I>x</I> is a <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A>, returns the <A REL=DEFINITION HREF="26_glo_d.htm#documentation_string"><I>documentation string</I></A> of the <A REL=DEFINITION HREF="26_glo_c.htm#class"><I>class</I></A> whose <A REL=DEFINITION HREF="26_glo_n.htm#name"><I>name</I></A> is the <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A> <I>x</I>, if there is such a <A REL=DEFINITION HREF="26_glo_c.htm#class"><I>class</I></A>. Otherwise, it returns the <A REL=DEFINITION HREF="26_glo_d.htm#documentation_string"><I>documentation string</I></A> of the <A REL=DEFINITION HREF="26_glo_t.htm#type"><I>type</I></A> which is the <A REL=DEFINITION HREF="26_glo_t.htm#type_specifier"><I>type specifier</I></A> <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A> <I>x</I>. <P>
|
||
|
|
If <I>x</I> is a <A REL=DEFINITION HREF="26_glo_s.htm#structure_class"><I>structure class</I></A> or <A REL=DEFINITION HREF="26_glo_s.htm#standard_class"><I>standard class</I></A>, returns the <A REL=DEFINITION HREF="26_glo_d.htm#documentation_string"><I>documentation string</I></A> associated with the <A REL=DEFINITION HREF="26_glo_c.htm#class"><I>class</I></A> <I>x</I>. <P>
|
||
|
|
<DT><A REL=DEFINITION HREF="#variable"><B>variable</B></A> <P><DD>
|
||
|
|
Returns the <A REL=DEFINITION HREF="26_glo_d.htm#documentation_string"><I>documentation string</I></A> of the <A REL=DEFINITION HREF="26_glo_d.htm#dynamic_variable"><I>dynamic variable</I></A> or <A REL=DEFINITION HREF="26_glo_c.htm#constant_variable"><I>constant variable</I></A> whose <A REL=DEFINITION HREF="26_glo_n.htm#name"><I>name</I></A> is the <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbol</I></A> <I>x</I>. <P>
|
||
|
|
<P></DL><P>
|
||
|
|
A <A REL=DEFINITION HREF="26_glo_c.htm#conforming_implementation"><I>conforming implementation</I></A> or a <A REL=DEFINITION HREF="26_glo_c.htm#conforming_program"><I>conforming program</I></A> may extend the set of <A REL=DEFINITION HREF="26_glo_s.htm#symbol"><I>symbols</I></A> that are acceptable as the <I>doc-type</I>. <P>
|
||
|
|
<P><B>Examples:</B> None.
|
||
|
|
<P>
|
||
|
|
<P><B>Affected By:</B> None.
|
||
|
|
<P>
|
||
|
|
<P><B>Exceptional Situations:</B> None.
|
||
|
|
<P>
|
||
|
|
<P><B>See Also:</B> None.
|
||
|
|
<P>
|
||
|
|
<P><B>Notes:</B><P>
|
||
|
|
<P>
|
||
|
|
This standard prescribes no means to retrieve the <A REL=DEFINITION HREF="26_glo_d.htm#documentation_string"><I>documentation strings</I></A> for individual slots specified in a <A REL=DEFINITION HREF="m_defcla.htm#defclass"><B>defclass</B></A> form, but <A REL=DEFINITION HREF="26_glo_i.htm#implementation"><I>implementations</I></A> might still provide debugging tools and/or programming language extensions which manipulate this information. Implementors wishing to provide such support are encouraged to consult the <A REL=DEFINITION HREF="26_glo_m.htm#metaobject_protocol"><I>Metaobject Protocol</I></A> for suggestions about how this might be done. <P>
|
||
|
|
<P><HR>The following <A REL=META HREF="../Front/X3J13Iss.htm">X3J13 cleanup issues</A>, <I>not part of the specification</I>, apply to this section:<P><UL><LI> <A REL=CHILD HREF="../Issues/iss308.htm">SETF-METHOD-VS-SETF-METHOD:RENAME-OLD-TERMS</A><LI> <A REL=CHILD HREF="../Issues/iss135.htm">DOCUMENTATION-FUNCTION-BUGS:FIX</A><P></UL><HR>
|
||
|
|
|
||
|
|
<A REL=NAVIGATOR HREF="../Front/StartPts.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Starting Points]" SRC="../Graphics/StartPts.gif" ALIGN=Bottom></A><A REL=TOC HREF="../Front/Contents.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Contents]" SRC="../Graphics/Contents.gif" ALIGN=Bottom></A><A REL=INDEX HREF="../Front/X_Master.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Index]" SRC="../Graphics/Index.gif" ALIGN=Bottom></A><A REL=INDEX HREF="../Front/X_Symbol.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Symbols]" SRC="../Graphics/Symbols.gif" ALIGN=Bottom></A><A REL=GLOSSARY HREF="../Body/26_a.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Glossary]" SRC="../Graphics/Glossary.gif" ALIGN=Bottom></A><A HREF="../Front/X3J13Iss.htm"><IMG WIDTH=80 HEIGHT=40 ALT="[Issues]" SRC="../Graphics/Issues.gif" ALIGN=Bottom></A><BR>
|
||
|
|
|
||
|
|
<A REL=COPYRIGHT HREF="../Front/Help.htm#Legal"><I>Copyright 1996-2005, LispWorks Ltd. All rights reserved.</I></A><P>
|
||
|
|
</BODY>
|
||
|
|
</HTML>
|