> I searched the howto but didn't find *the* way to properly document an
> extension constants. Personnaly, I'd like to see the errorfunc way
> everywhere (value, constant name, description, note). Was any decision
> made yet ?
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.
- Location of constant information
The constants section can get quite large (especially when descriptions
are added!) so having all of this information inline the reference at
php.net/ref.{ext} can be a little overwhelming. If this were to be in its
own section/page, and linked to where the reftitle.constants currently
exists, as well as on top of the individual reference TOC's, this might
work pretty well.
> PS: Philip, can you integrate the final decision while rewriting the
> howto ? thanks :)
Sure, when this is figured out I'll be happy to insert the information
into the HOWTO :)
Regards,
Philip
