News Feed
Sections




News Archive
Looking for more information on how to do PHP the right way? Check out PHP: The Right Way

Kevin van Zonneveld's Blog:
7 Steps to better PEAR documentation
February 23, 2009 @ 11:11:55

Kevin van Zonneveld has posted seven steps that you can follow to help the documentation for your PEAR class come out better and be more useful in the end.

If you've written a PEAR package, it's probably a good idea to submit some end user documentation. Here's how to do it.

He explains what it is (XML in CVS, easily convertible with phpd) and how the process flows - save the current docs, add your own, build locally and submit to CVS. Here's his tips to help things go smoothly/turn out better:

  • Gather the prerequisites
  • Save current documentation
  • Try building the docs
  • Write your own XML docs
  • ReBuild peardoc
  • Commit your XML
  • (There is no seventh step - you're done!)
0 comments voice your opinion now!
better pear documentation steps xml cvs phpd build submit package


blog comments powered by Disqus

Similar Posts

Greg Beaver's Blog: PhpDocumentor 1.3.0 stable is released

Community News: Latest PEAR Releases for 08.13.2007

Pierre-Alain Joye's Blog: Build cairo on windows, step #1

Builder.com: Search and map directory trees with ease using the right PHP class

Derick Rethans\' Blog: Parsing Mail with PHP


Community Events





Don't see your event here?
Let us know!


community framework voicesoftheelephpant update opinion interview introduction security podcast symfony laravel language release version composer library install tool package series

All content copyright, 2014 PHPDeveloper.org :: info@phpdeveloper.org - Powered by the Solar PHP Framework