Re: Re: PEAR Guide/Docs
| From: | Jon Wood | Date: | Thu, 27 Mar 2003 23:31:24 +0000 |
| Subject: | Re: Re: PEAR Guide/Docs | ||
| References: | 1 2 3 4 | Groups: | php.pear.general |
| Request: | Send a blank email to pear-general+get-4476@lists.php.net to get a copy of this message | ||
On Thu, 2003-03-27 at 22:58, Gunther wrote:
> Yes, out of date is always a problem with documentation!!
> Well, I have to be fair ....
> http://vulcanonet.com/soft/pear_tut/ is also not providing
> further information about the functions (commit, rollback etc.),
> but at least they are mentioned there (beside the source code).
> I saw some stuff which looks like source code documentation
> http://dickmann.homeunix.org/pear/phpdoc/PEAR/DB/1.2/li_DB.html
> But no guide/tutorial/howto on how to use PEAR.
> Unix, Linux etc. were quite good ... initially there are almost always
> simple text Howto's available. Later more advanced documentation was
> added. But still, the howto's are closer to development, just after the
> "Readme's" ;-)
> or souce code.
>
> I still do not really know where else I get information other
> than the PEAR manual.
Try http://cvs.php.net/cvs.php/pear where you can find
the source code
for all the packages in PEAR (and a few that aren't in yet), the source
for each of the packages contains API documentation, which I find is the
most useful thing.
Jon
>
> Gunther
>
> "Jon Wood" <jon@jellybob.co.uk> wrote in message
> news:<1048804536.527.31.camel@bertha.2of3.co.uk>...
> >
> > > But for PEAR ... I really do not know. It is an ongoing project and
> > > therefore the source code is
> > > the best help. I could imagine that docbook is extracting comments from
> the
> > > sourcecode. That would
> > > keep things more simple for the developer as there would be no need to
> write
> > > separate documentation.
> > >
> > > Quick example ... looking through the helpful PEAR manual:
> > > http://pear.php.net/manual/en/
> > > for DB commit, rollback, autocommit functions (which I am using now), I
> do
> > > not find anything there.
> > > But I find it in the pear/DB.php and pear/DB/mssql.php source code.
> > > A google search for "PEAR DB rollback" will finally lead me to the right
> > > site:
> > > http://vulcanonet.com/soft/pear_tut/ . This page
> > > contains much more
> > > information about PEAR DB than ...
> > At the moment the documentation on the PEAR website is a bit (ok, quite
> > a lot) out of date, since the code that will eventually generate the API
> > docs from the source code is under development, so your best bet is, as
> > you said, to look through the comments in the code itself.
> >
> > Jon
> >
>
>