Re: PEAR_Info Documentation
| From: | Davey | Date: | Sat, 26 Apr 2003 00:45:21 +0000 |
| Subject: | Re: PEAR_Info Documentation | ||
| References: | 1 2 | Groups: | php.pear.doc |
| Request: | Send a blank email to pear-doc+get-658@lists.php.net to get a copy of this message | ||
Xavier,
Thanks, I will change my local file name now.
The docs look just fine, although I am not sure I have written them correctly, for example, the synopsis for all the function is "require('PEAR/Info.php');", should it be $info->show(); (for example)?
And the last thing, the other two function (getPackages() and showCredits()) should never be called outside the class (they would be private if PHP4 supported that) how can I indicate that?
- Davey
Xavier Noguer wrote:
A few observations: - pear_info.xml should be pear-info.xml (composed names always use hyphens) - as it is, this docs will end up in the packages section, on it's own pear section. You can find the generated docs here: http://www.dcc.uchile.cl/~xnoguer/peardoc2/package.pear.html If everything is OK I can add it to cvs. El Vie 25 Abr 2003 05:46, Davey escribió:I have just completed what I believe to be accurate PEAR_Info docs. However, as I have no idea on how exactly you wants the docs (more info on that on the website would be great!) I just cut and pasted the XML_RSS docs and modified to my needs... hope that is OK. If you could please check my docs to see they are in the correct format (if not, tell me where I can get an example of the correct format and I will re-do them). My docs can be found here: http://www.pixelated-dreams.com/~davey/PEAR/release/Info-docs.zip if they are correct, can someone inform me as to where I go from here to put them on to the website (or in the position to be built for the website) - Davey