Re: new docs..help

On Feb 22, 2004, at 8:29 PM, Stefan Neufeind wrote:

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.

Thanks, I will try to do that. But .. just for the record. Some packages (the majority I have been in touch with) are well documented. They are just documented the wrong way. I wouldn't dare to tell a developers to do it my way, or better said the PhpDocumentor way. I will post them a friendly note..let's see. Thanks for your hint.

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).

Okay I will do make test and I will move on asap.

Thanks for your contributions. Regards, Stefan