Hi list,
I think a new exceptions refsect1 is a better idea.
The PEAR docs do this: see http://pear.php.net/manual/en/package.database.db.db-common.commit.php
Yep, this is definitely needed. I think we can use something like :
<refsect1 role="exceptions">
&reftitle.exceptions;
<para>
<variablelist>
<varlistentry>
<term><constant>DOM_INDEX_SIZE_ERR</constant></term>
<listitem>
<para>
This is raised when <parameter>index</parameter> is negative.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>(Nuno, the code is documented within the constants section, maybe it's better to hide it si that people use constants instead)
Also, I think we need another section for misc information.
When documenting mysql_query in the new format, I really needed a place just to dump the rest of the information (I put the extra information in the Return section). Perhaps we can make a "Note" section (as in pear).
see http://livedocs.homelinux.com/en/function.mysql-query.html
I don't know, for dom, I distributed the notes and warning where appropriated (parameters, description, returnvalues), it's more consistent IMHO.
didou
