Re: Final push towards PHP 4 release
| From: | Andi Gutmans | Date: | Sun, 12 Mar 2000 18:47:55 +0000 |
| Subject: | Re: Final push towards PHP 4 release | ||
| References: | 1 | Groups: | php.dev |
| Request: | Send a blank email to php-dev+get-16721@lists.php.net to get a copy of this message | ||
Egon,
We think the work you guys are doing on the documentation is really great.
As you know, there are tons of Emails from users with very positive
feedback about PHP's documentation.
I want to encourage all of the cvs-committers to add documentation
function prototypes to their work. It only takes a few minutes.
Thanks,
Andi
On Sun, 12 Mar 2000, eschmid wrote:
> On Sun, 12 Mar 2000, Andi Gutmans wrote:
>
> > Please take some time to go through them. Also, if there is any work
> > you still need to do before an RC 1 please speak up. I think there are a
> > couple of modules such as the DAV module which haven't been ported from
> > PHP 3. We should make a list of such modules.
>
> And please note that in PHP 4 are many new and old functions without
> proper function prototypes as recommended in CODING_STANDARDS under
> "Documentation and Folding Hooks".
>
> I think it was also in the paper, Rasmus wrote after the first conference,
> but I cannot find that document after the relaunch of the zend site.
>
> I have spent so much time during my holidays to fix that badly formatted
> function prototypes and it would be a bad idea not maintaining it in the
> future. IIRC the O'Reilly book will never be published, when documentation
> and source will differ.
>
> In the phpdoc repository are some AWK programs to demonstrate this:
>
> ./genfunclist ../path/to/php3/or/php4 > funclist.txt
> ./genfuncsummary ../path/to/php3/or/php4 > funcsummary.txt
> ./checkdoc ../path/to/php3/or/php4 > checkdoc.txt
>
> DocBook is not needed. After the last command (checkdoc) you will see how
> many functions are documented. In PHP3 about 1400 and in PHP4 only 1200.
>
> There are some minor problems to this numbers. MySQL functions counts
> aliases as well and never existing (yp_error) functions are counted as
> documented because this functions are commented out in the documentation.
>
> -Egon
>
>
>