PHP Documentation - A proposed new/changed role for errors

You are viewing an archived Text-only version of the thread. To view this thread in it's original format and/or if you want to reply to this thread please [click here]

Author

A proposed new/changed role for errors

Philip Olson

2006-08-31, 6:57 pm

Hello all!

We currently have the following roles for function documentation:

description
parameters
returnvalues
exceptions
unicode
changelog
examples
notes
seealso

This is a proposal to rename 'exceptions' to 'errors' so it may
cover, for example, when functions emit E_* level errors. Currently
this information is either in the description, returnvalues, or
notes roles but none of those are fully appropriate. Exception
information would be put into the errors role. We could have both
(errors and exceptions roles) but that doesn't seem needed. Thoughts?

Regards,
Philip

Sponsored Links