Re: ref.dom

From: Date: Sun, 02 Jan 2005 07:06:15 +0000
Subject: Re: ref.dom
References: 1 2  Groups: php.doc 
Request: Send a blank email to phpdoc+get-969365753@lists.php.net to get a copy of this message
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 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 Best wishes, Aidan "Nuno Lopes" <nlopess@php.net> wrote in message news:005101c4ef6d$49f31e40$0100a8c0@pc07653... >> Hi ! >> >> I think I finished my work on the DOM extension, comments and >> (grammatical) reviews are welcome. >> >> I needed to add a new refsect1 (role="exceptions") but I'm not >> sure of the structure. Do we use a list like for parameters ? >> Opinions ? >> >> didou > > > Hi, > > AFAIK, there isn't an extension with exceptions documented... > I think the better is to use a table with three columns: error code, > message and description. It's enough, IMHO. > > Nuno > > > (BTW, I've found tha docbook has <OOexception> and <exceptionname>, but I > don't think we need them)

« previous php.doc (#969365753) next »