Re: Package Submission & Documentation Questions
| From: | Martin Jansen | Date: | Wed, 13 Aug 2003 15:55:04 +0000 |
| Subject: | Re: Package Submission & Documentation Questions | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-19678@lists.php.net to get a copy of this message | ||
On Wed Aug 13, 2003 at 10:0854AM -0500, Joe Stump wrote:
> I've created a simple new package, Mail_RFC2822,
There is already a class to validate addresses:
http://cvs.php.net/co.php/pear/Mail/Mail/RFC822.php
What are the differences? Can you integrate your code into Mail_RFC822?
> 1.) Who do I consult about a new package? The new package link goes to
> a login screen with no link to register.
Usually one approaches this mailing list and describes the new
package. The developers will then start discussing about it and will
give votes (+1/-1). Once that you have 5 +1 votes and no strong
objections from someone, you can go ahead by signing up for a PEAR
account on http://pear.php.net/account-request.php. Once you
got that
account, you can register the new package.
> 2.) I notice the documentation *appears* to be generated from the
> PHPDocumentor tags in the code, but I see no reference in how to create
> my own (or is this done when I submit the package?).
Currently we do not automatically generate documentation from the API
docs, but this is on the todo list. Instead the documentation is written
in Docbook XML. (PHPDocumentor can be used to convert the API docs to
Docbook, but you still need to add it manually to the documentation.)
--
- Martin Martin Jansen
http://martinjansen.com/