Re: cvs: phpdoc /scripts xml_proto.php

A lot of people might not know the info is there, but instead of removing it entirely I would suggest using an option to enable/disable it. The skeleton created should still be obvious to people who do not know much (if anything) about the way php-doc is made. So IMO it's not obvious to everyone that the description of that paremeter should go into that <para></para> section. Adding a switch (defaulting to off if you wish) would make it easier to create one with extra "debug" info which is useful to write the actual documentation. If people just want a raw skeleton, with _no_ additional manual editing involved, they should run it with a different flag/option/switch. - Tul Philip Olson wrote:

philip Mon Aug 27 21:05:31 2007 UTC

  Modified files:                  /phpdoc/scripts	xml_proto.php   Log:

Removing debug information as people tend to commit this bogus information as is. http://cvs.php.net/viewvc.cgi/phpdoc/scripts/xml_proto.php?r1=1.53&r2=1.54&diff_format=u Index: phpdoc/scripts/xml_proto.php diff -u phpdoc/scripts/xml_proto.php:1.53 phpdoc/scripts/xml_proto.php:1.54 --- phpdoc/scripts/xml_proto.php:1.53 Wed Aug 22 22:24:10 2007 +++ phpdoc/scripts/xml_proto.php Mon Aug 27 21:05:31 2007 @@ -16,7 +16,7 @@

   | Authors:   Brad House <bradmssw@php.net>                             |

+----------------------------------------------------------------------+ - $Id: xml_proto.php,v 1.53 2007/08/22 22:24:10 philip Exp $ + $Id: xml_proto.php,v 1.54 2007/08/27 21:05:31 philip Exp $ */ /* @@ -272,7 +272,6 @@

             "     <term><parameter>{$argname}</parameter></term>\n" .
             "     <listitem>\n" .
             "      <para>\n" .
-            "       Its description\n" .
             "      </para>\n" .
             "     </listitem>\n" .
             "    </varlistentry>\n";

@@ -285,8 +284,6 @@

         " <refsect1 role=\"returnvalues\">\n" .
         "  &reftitle.returnvalues;\n" .
         "  <para>\n" .
-        "   What the function returns, first on success, then on failure. See\n" .
-        "   also the &amp;return.success; entity\n" .
         "  </para>\n" .
         " </refsect1>\n"
     );