A.3. Reference Entries

Elements shown in context

    <refentry id="re-functionx">
      <refnamediv>
        <refname>function_x</refname>
        <refpurpose>performs function x.</refpurpose>
        <indexterm id="ix-functionx"><primary>function_x</primary></indexterm>
      </refnamediv>
      <refsynopsisdiv>
        <title>Syntax</title>
        <![ %include.gamma [
        <synopsis>
<literal>
function_x (parameter1, parameter2)
</literal>
        </synopsis>
        ]]>
        <![ %include.lisp [
        <synopsis>
<literal>
(function_x parameter1 parameter2)
</literal>
        </synopsis>
        ]]>
      </refsynopsisdiv>
      <refsect1>
        <title>Arguments</title>
        <variablelist>
          <varlistentry>
            <term><parameter>parameter1</parameter></term>
            <listitem><para>Explanation.</para></listitem>
          </varlistentry>
          <varlistentry>
            <term><parameter>parameter2</parameter></term>
            <listitem><para>Explanation.</para></listitem>
          </varlistentry>
        </variablelist>
      </refsect1>
      <refsect1>
        <title>Returns</title>
        <para>Explanation.</para>
      </refsect1>
      <refsect1>
        <title>Description</title>
        <para>Explanation.</para>
      </refsect1>
      <refsect1>
        <title>Example</title>
        <para>Code.</para>
      </refsect1>
      <refsect1>
        <title>See also</title>
        <para>Links.</para>
      </refsect1>
    </refentry>