Re: future of PEAR
| From: | Greg Beaver | Date: | Tue, 11 Nov 2003 15:26:59 +0000 |
| Subject: | Re: future of PEAR | ||
| References: | 1 2 3 4 5 6 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-23446@lists.php.net to get a copy of this message | ||
Hi,
I think you all need to know about
http://phpdoc.org/docs/HTMLframesConverter/earthli/phpDocumentor/tutorial_tutorials.pkg.html
If you write your tutorials in this format, you will never - repeat - never need to hand-edit the output from phpDocumentor.
In addition, if you decide you don't like something about the peardoc converter, all the files to generate docbook are templates - it's relatively simple to go in and change the template or copy it to a new directory (and send your results back to me, I will include them in the next release if they have general interest)
Greg
Michael Wallner wrote:
Hi Stefan Neufeind, you wrote:So how would you actually write docs? Use phpDocumentor to generate docbook from the source (phpdoc-comments) and then edit the docbook-files to extend the doc? What if you make changes to the code - then you have to write the docbook- files again and again? Or is there a way to simply "update" them? Sorry, haven't yet figured out how to work with all those "tools" :-((Well, actually I write them by hand - and yes that's in deed a problem. I could think this way: generate API docs with PhpDocumentor and add extra docs, intros etc by hand in *extra files* - just linking them...What does it generate? How? I think writing tests also needs some further explanation on this list ... but I will ask about that when the other discussions are threw :-)PHPEdit has aplugin called PHPXUnit (I think), which generates an almost complete Testcase of an PHP class - of course the methods of the test cases are empty :) Have a look at the File_Passwd unit tests, which skeletons are generated by PHPEdit. Regards,