Re: new docs..help

From: Date: Sun, 22 Feb 2004 19:29:34 +0000
Subject: Re: new docs..help
References: 1  Groups: php.pear.doc 
Request: Send a blank email to pear-doc+get-2685@lists.php.net to get a copy of this message
On 22 Feb 2004 at 19:57, David Costa wrote: > sorry to harp on with this but I need some comments re: > > http://lists.php.net/article.php?group=php.pear.doc&article=2655 > > else I cannot finish it. About the general request for better inline-documentation using phpdoc-comments: Yes, this would help a lot. If possible please negotiate with the respective package-maintainers about their plans for the classes and arrange to maybe provide patch-files against their latest (CVS-)sources that will enrich them with additional documentation in phpdoc-format. Imho this would be far better to also have cleanly structured and documented source at the same time than just documenting for the manual and not being able to keep track of source-code changes easily. Most devs possibly simply haven't tried with the latest phpDocumentor-releases or don't have time to add the documentation to their packages. So your help in that respect would surely be appreciated. About your documentation for Net_SMTP: I haven't tried the manual- sources out yet. But they look well done. However be sure to do proper checks (using "make test") before committing. And also negoatiate with the package-leads for integration in phpdoc-style into the sourcecode directly (see comment above). Thanks for your contributions. Regards, Stefan

« previous php.pear.doc (#2685) next »