Changeset 12096


Ignore:
Timestamp:
May 20, 2009, 1:18:14 AM (10 years ago)
Author:
gz
Message:

ugh, try to use standard dictionary format

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/source/doc/src/gc.xml

    r12094 r12096  
    278278      invoking <literal>gc</literal>, to get the object out of the
    279279      REPL variables.</para>
    280 
    281 
    282       <para>
    283         <indexterm zone="f_make-population"/>
    284         <command><varname id="f_make-population">MAKE-POPULATION</varname>
    285            &key; <parameter>type</parameter> <parameter>initial-contents</parameter>
    286         [Function]</command>
    287       </para>
    288 
    289     <variablelist>
    290       <varlistentry>
    291         <term><varname>type</varname></term>
    292         <listitem>
    293           <para>The type of population, one of <literal>:LIST</literal> (the default) or <literal>:ALIST</literal></para>
    294         </listitem>
    295       </varlistentry>
    296       <varlistentry>
    297         <term><varname>initial-contents</varname></term>
    298         <listitem>
    299           <para> A sequence of elements (or conses, for <literal>:alist</literal>) to be used to initialize the
    300             population. The sequence itself (and the conses in case of an alist) is not stored, a new list
    301             or alist is created to be stored in the population.</para>
    302         </listitem>
    303       </varlistentry>
    304     </variablelist>
    305 
    306     <para>Creates a new population of the specified type.</para>
    307 
    308 
    309     <para>
    310       <indexterm zone="f_population-type"/>
    311       <command><varname id="f_population-type">POPULATION-TYPE</varname>  <parameter>population</parameter>
    312         [Function]</command>
    313     </para>
    314 
    315     <para>returns the type of <literal>population</literal>, one of <literal>:LIST</literal> or <literal>:ALIST</literal></para>
    316 
    317     <para>
    318       <indexterm zone="f_population-contents"/>
    319       <command><varname id="f_population-contents">POPULATION-CONTENTS</varname>  <parameter>population</parameter>
    320         [Function]</command>
    321     </para>
    322 
    323     <para>returns the list encapsulated in <literal>population</literal>.  Note
    324     that as long as there is a direct (non-weak) reference to this list, it will
    325     not be modified by the garbage collector.  Therefore it is safe to traverse
    326     the list, and even modify it, no different from any other list. If you want the
    327     elements to become garbage-collectable again, you must stop refering to the
    328     list directly.</para>
    329 
    330     <para>
    331       <indexterm zone="f_setf_population-contents"/>
    332       <command>(SETF (<varname id="f_setf_population-contents">POPULATION-CONTENTS</varname> <parameter>population</parameter>) <parameter>contents</parameter>)
    333               [Function]</command>
    334     </para>
    335 
    336     <para>Sets the list encapsulated in <literal>population</literal> to <literal>contents</literal>.  <literal>Contents</literal> is not copied, it is used directly.</para>
     280    </sect1>
     281
     282    <sect1 id="Weak-References-Dictionary">
     283      <title>Weak References Dictionary</title>
     284
     285    <refentry id="f_make-population">
     286      <indexterm zone="f_make-population">
     287        <primary>make-population</primary>
     288      </indexterm>
     289
     290      <refnamediv>
     291        <refname>MAKE-POPULATION</refname>
     292        <refpurpose></refpurpose>
     293        <refclass>Function</refclass>
     294      </refnamediv>
     295       
     296      <refsynopsisdiv>
     297        <synopsis><function>make-population</function> &key; type initial-contents</synopsis>
     298      </refsynopsisdiv>
     299
     300      <refsect1>
     301        <title>Arguments and Values</title>
     302
     303        <variablelist>
     304          <varlistentry>
     305            <term>type</term>
     306            <listitem>
     307              <para>The type of population, one of <literal>:LIST</literal> (the default) or <literal>:ALIST</literal></para>
     308            </listitem>
     309          </varlistentry>
     310
     311          <varlistentry>
     312            <term>initial-contents</term>
     313            <listitem>
     314              <para> A sequence of elements (or conses, for <literal>:alist</literal>) to be used to initialize the
     315              population. The sequence itself (and the conses in case of an
     316              alist) is not stored in the population, a new list or alist is created to hold the elements.</para>
     317            </listitem>
     318          </varlistentry>
     319        </variablelist>
     320      </refsect1>
     321      <refsect1>
     322        <title>Description</title>
     323
     324        <para>Creates a new population of the specified type.</para>
     325      </refsect1>
     326    </refentry>
     327
     328    <refentry id="f_population-type">
     329      <indexterm zone="f_population-type">
     330        <primary>population-type</primary>
     331      </indexterm>
     332
     333      <refnamediv>
     334        <refname>POPULATION-TYPE</refname>
     335        <refpurpose></refpurpose>
     336        <refclass>Function</refclass>
     337      </refnamediv>
     338     
     339      <refsynopsisdiv>
     340        <synopsis><function>population-type</function> population</synopsis>
     341      </refsynopsisdiv>
     342
     343      <refsect1>
     344        <title>Description</title>
     345
     346        <para>returns the type of <literal>population</literal>, one of <literal>:LIST</literal> or <literal>:ALIST</literal></para>
     347
     348      </refsect1>
     349    </refentry>
     350
     351    <refentry id="f_population-contents">
     352      <indexterm zone="f_population-contents">
     353        <primary>population-contents</primary>
     354      </indexterm>
     355
     356      <refnamediv>
     357        <refname>POPULATION-CONTENTS</refname>
     358        <refpurpose></refpurpose>
     359        <refclass>Function</refclass>
     360      </refnamediv>
     361     
     362      <refsynopsisdiv>
     363        <synopsis><function>population-contents</function> population</synopsis>
     364      </refsynopsisdiv>
     365
     366      <refsect1>
     367        <title>Description</title>
     368
     369        <para>returns the list encapsulated in <literal>population</literal>.
     370        Note that as long as there is a direct (non-weak) reference to this
     371        list, it will not be modified by the garbage collector.  Therefore it is
     372        safe to traverse the list, and even modify it, no different from any
     373        other list. If you want the elements to become garbage-collectable
     374        again, you must stop refering to the list directly.</para>
     375      </refsect1>
     376    </refentry>
     377
     378
     379    <refentry id="f_setf_population-contents">
     380      <indexterm zone="f_setf_population-contents">
     381        <primary>(setf population-contents)</primary>
     382      </indexterm>
     383
     384      <refnamediv>
     385        <refname>(SETF POPULATION-CONTENTS)</refname>
     386        <refpurpose></refpurpose>
     387        <refclass>Function</refclass>
     388      </refnamediv>
     389     
     390      <refsynopsisdiv>
     391        <synopsis>(setf (<function>population-contents</function> population) contents)</synopsis>
     392      </refsynopsisdiv>
     393
     394      <refsect1>
     395        <title>Description</title>
     396
     397        <para>Sets the list encapsulated in <literal>population</literal> to
     398        <literal>contents</literal>.  <literal>Contents</literal> is not copied,
     399        it is used directly.</para>
     400      </refsect1>
     401    </refentry>
    337402
    338403    </sect1>
Note: See TracChangeset for help on using the changeset viewer.