Re: php_error_docref

At 22:04 13.08.2002, Dan Kalowsky wrote:

On Tue, 13 Aug 2002, Marcus [iso-8859-1] Börger wrote: The point is to be able to direct to external sites not on php.net! For example when a function is just a wrapper around a library then you can use the absolute form of the docref parameter ("http://<site>") to point to the library's website. Okay thats a point I hadn't thought of. Though I'm not sure why we'd be referencing outside sites. Can we then change the CODING_STANDARD example to NOT use the php.net website? Hopefully stopping anyone from using it as a reference to any php-specific documentation, and only for external sites. NULL or "#<target>" is best here since it allows the phpdoc group to change their mind for naming the pages. Then again, I don't understand what this parameter is for. If not for the developer to declare which help file this is in, what is the point? Yes I see the anchor tags option, but what is the difference between using an anchor and declaring specifically?

It is there for directing to one specific page. For example i am going to write the common errors for exif only on the exif_read_data page. So i must set docref parameter of all calls to php_error_docref() within exif to exif-read-data#error. Another problem is that you can direct to configuration pages and so on if the error coccured due to a missconfiguration.

It just seems that if this variable is going to be 90% of the time (random guess) NULL, it's not really all the necessary to be included.

It was intended to be the right parameter for abot 95%.

And judging from the comment by Gabor, the PHPDOC group isn't going to change this format anytime soon.

I hoped so :-) marcus