* Octavian Rasnita <[EMAIL PROTECTED]>: > Well, it seems that PHP libraries don't have the documentation included... > This is too bad, because it is much harder to search in the PHP manual, and > some libraries that might be downloaded from different sites and made by > different programmers won't have the documentation included in the PHP > manual. > > I thought PHP also have a kind of program like perldoc for perl which can > display the documentation for a built in function, for a library that was > installed, plus different tutorials... > > I guess it would be a good idea to implement such a thing in PHP also, > including a documentation in comments, with some special marks...
Okay, what you're talking about has to do not with the standard PHP distribution but with classes and scripts created by PHP programmers. If you get them from PEAR, you will usually have documentation -- this is one of the foci of the PEAR project, standard and well-documented modules. On the other hand, if you get them from another source, you have to rely on the programmer(s) creating the documentation. There are already some standard PHP documentation systems, the most prevalent of which is PHPDocumentor (available via PEAR as well as phpdoc.org). It creates web-based documentation that you can then peruse at your leisure; for an example, look at the PEAR site's package documentation (which isn't strictly PHPDoc, but many of the package authors use PHPDoc to create their documentation). > ----- Original Message ----- > From: "M. Sokolewicz" <[EMAIL PROTECTED]> > To: <[EMAIL PROTECTED]> > Sent: Sunday, August 22, 2004 11:29 AM > Subject: [PHP] Re: Reading the documentation > > >> Octavian Rasnita wrote: >> > Hi all, >> > >> > I have 2 questions: >> > >> > 1. Do PHP libraries have a documentation included inside of them like in >> > case of Perl's modules? >> > >> > 2. If yes, how can I read that documentation? >> > >> > Thank you. >> > >> > Teddy >> that would depend on what you understand under the term "PHP libraries", >> if you mean the actual C files, then no, if you mean the PHP extensions, >> eg. mysql, mcrypt, XML, etc. then yes, they do have documentation (most >> of them), which can be found in the PHP Manual available on php.net. If >> you're talking about the PECL extensions, then they usually don't have >> much, if any, documentation about it. It basically means you'd need to >> read the C code for it and find out yourself... > > >> hope that helped, >> - Tul -- Matthew Weier O'Phinney | WEBSITES: Webmaster and IT Specialist | http://www.garden.org National Gardening Association | http://www.kidsgardening.com 802-863-5251 x156 | http://nationalgardenmonth.org mailto:[EMAIL PROTECTED] | http://vermontbotanical.org -- PHP General Mailing List (http://www.php.net/) To unsubscribe, visit: http://www.php.net/unsub.php
