cvs: php4 / CODING_STANDARDS

From: Date: Tue, 13 Aug 2002 20:55:42 +0000
Subject: cvs: php4 / CODING_STANDARDS
Groups: php.cvs 
Request: Send a blank email to php-cvs+get-13327@lists.php.net to get a copy of this message
helly Tue Aug 13 16:55:42 2002 EDT Modified files: /php4 CODING_STANDARDS Log: -better use external example -say NULL is intended -correct example #hope this is a bit easier to understand and clears it a bit Index: php4/CODING_STANDARDS diff -u php4/CODING_STANDARDS:1.15 php4/CODING_STANDARDS:1.16 --- php4/CODING_STANDARDS:1.15 Tue Aug 13 05:42:51 2002 +++ php4/CODING_STANDARDS Tue Aug 13 16:55:42 2002 @@ -64,21 +64,21 @@ This can be done automatically using php_error_docref(). The first parameter, docref, is either NULL or the URL of a page describing the - error in detail. If you pass NULL, the reference is generated from - the name of the function being executed: + error in detail. In most cases you will pass NULL, to generate the URL + from the name of the function being executed: php_error_docref(NULL TSRMLS_CC, E_WHATEVER, "Desc."); If you pass a URL, it can either be a full URL beginning with "http://": - php_error_docref("http://www.php.net/manual/en/function.fopen#error" + php_error_docref("http://externalsite.tld/page.ext#error" TSRMLS_CC, E_WHATEVER, "Desc."); Or the name of a manual page without file extension, but with an optional target anchor. Or simply the anchor within the manual page of the current function. When using function names you must replace '_' by '-': - php_error_docref("function.ext_func#error" TSRMLS_CC, E_WHATEVER, "Desc."); + php_error_docref("function.ext-func#error" TSRMLS_CC, E_WHATEVER, "Desc."); To display one or two important parameters after the function name, use php_error_docref1() or php_error_docref2(). For example, file functions

« previous php.cvs (#13327) next »