Re: documenting constants

From: Date: Thu, 09 Sep 2004 18:13:54 +0000
Subject: Re: documenting constants
References: 1  Groups: php.doc 
Request: Send a blank email to phpdoc+get-969363920@lists.php.net to get a copy of this message
Two main topics come to mind here: - Layout of constant information As far as I see it, they're all ready for descriptions but are rarely added as it means a lot of extra work looking them all up, and putting that information into laymen's terms (or coming up with a description that isn't simply the constant name written out). If these constant lists should be in a table, or the current variablelist, I don't know. The mysqli table uses a two column table, the ref.info table three, and the errorfunc table has four; and most all other extensions use a variablelist with an empty description simpara with the idea of later adding the description. Either layout works for me, they each have their pros and cons.
If we start adding descriptions for constants, a table might easily get out of control, having constant names with a lot of useless vertical space in cells, while the corresponding description stretches the table cell. Or is this already solved? :) [I am reading through old but kept issues.] Goba

« previous php.doc (#969363920) next »