[PHP-DOC] cvs: phpdoc /howto working.xml

[Gabor Hojtsy]

goba            Wed Jan  9 04:44:42 2002 EDT

  Modified files:              
    /phpdoc/howto       working.xml 
  Log:
  Add new convention, as noone complained about it till this time :)
  
  
Index: phpdoc/howto/working.xml
diff -u phpdoc/howto/working.xml:1.12 phpdoc/howto/working.xml:1.13
--- phpdoc/howto/working.xml:1.12       Sat Dec 15 05:34:33 2001
+++ phpdoc/howto/working.xml    Wed Jan  9 04:44:42 2002
@@ -192,6 +192,17 @@
       --Jeroen</simpara></footnote>, since it can be either
       array or string.
      </simpara>
+     
+     <simpara>
+      Do not use <literal>mixed</literal>, if the return
+      value is of a certain (not boolen) type, and FALSE
+      only on error. Provide the primary return type as
+      the return type of the function, and write down in
+      the explanation, that it returns FALSE on error.
+      Use <literal>&amp;return.success;</literal> if the
+      function returns TRUE on success, and FALSE on
+      failure.
+     </simpara>
 
      <simpara>
       If a function requires no arguments, use