documentation for a package in php?

Posted by ajsie on Stack Overflow See other posts from Stack Overflow or by ajsie
Published on 2010-04-07T10:56:46Z Indexed on 2010/04/07 11:53 UTC
Read the original article Hit count: 308

Filed under:

phpdoc

|

php

so in a folder PayPal i've got multiple classes for using their API.

i want to make a documentation for how to use all the classes in a sequential way. so here is my questions:

how do i create a package for them? cause above each class i used phpdoc tag @package PayPal. is a package in php just a folder?
where do i put documentation for the package? there are best practices for this? a file in the folder named ...?
how to put class- or package-specific examples, eg. step 1 bla bla, step 2 bla bla? thanks!

© Stack Overflow or respective owner

Related posts about phpdoc

can't find phpdoc binary?

as seen on Super User - Search for 'Super User'
i've downloaded the phpdoc from their site, extracted it and put it in apache's documentroot for access through the web browser. however, i cant access the "phpdoc" tool from the command line. i have to add it to a Path but i cant find it in the extracted folder. where is it? >>> More
Can't find the PHPdoc binary file

as seen on Super User - Search for 'Super User'
I've downloaded the phpdoc from their site, extracted it, and put it in apache's documentroot for access through the web browser. However, I cant access the phpdoc tool from the command line. I have to add it to the PATH because I want to use the command line for automated documentation building… >>> More
PHPDoc Function Changelog (@change?)

as seen on Stack Overflow - Search for 'Stack Overflow'
What is the best way to document changes in a function with PHPDoc? Something like @change 2010.20.16 user added feature x @change 2010.20.26 user added feature y would be great. But assume there's no @change option... If i add it anyways, what will PHPDoc do with it? Or is there a better /… >>> More
What kind parser that phpdoc use ?

as seen on Stack Overflow - Search for 'Stack Overflow'
When the first time, i install phpdoc, i love it so much. And i want to create its mini version for myself use. So, can anybody give me information about what kind of parser it has. and Maybe a image reference on how it works (so i can picture it visually in my mind) ? >>> More
multiple subpackages for phpdoc

as seen on Stack Overflow - Search for 'Stack Overflow'
Is it possible to have a file belong to multiple subpackages? For example: /** * Name * * Desc * * @package Core * @subpackage Sub1 * @subpackage Sub2 */ Thanks! >>> More

Related posts about php

Magento, NGINX, PHP-FPM, APC, MEMCACHED, 16gb Ram CentOS, Spiking PHP-FPM to 100% CPU

as seen on Server Fault - Search for 'Server Fault'
I have been trying to resolve my issue of spiking cpu caused by php-fpm processes. I've reduced the php-fpm config settings to: pm = ondemand pm.max_children = 12 pm.start_servers = 2 pm.min_spare_servers = 2 pm.max_spare_servers = 10 pm.max_requests = 500 php_admin_value[memory_limit] = 128M Problem… >>> More
PHP Pear Installation on CentOS

as seen on Server Fault - Search for 'Server Fault'
[root@ip ~]# yum install php-pear* Reducing CentOS-5 Testing to included packages only Finished Setting up Install Process Package 1:php-pear-1.8.1-2.el5.centos.noarch already installed and latest versio … >>> More
Apache configurations for php "AddType text/html php" or "AddType application/x-httpd-php php .php"

as seen on Server Fault - Search for 'Server Fault'
I am taking over an application server and discover that it contain the following settings: AddType text/html php Although it works, but my understanding is that it should set as following: AddType application/x-httpd-php php .php What are the key differences between the two settings?… >>> More
mod_rewrite settings causes server to throw HTTP 500 errors instead of 404

as seen on Server Fault - Search for 'Server Fault'
Hello. I have a server with VBulletin forum (working under Apache 2.2, CentOS). The default settings for it in .htaccess are as follows: RewriteEngine on RewriteCond %{HTTP_HOST} ^gsmforum\.ru RewriteRule (.*) http://www.gsmforum.ru/$1 [R=301,L] # If you are having problems or are using VirtualDocumentRoot… >>> More
Problems installing Memcache (PECL extension)

as seen on Server Fault - Search for 'Server Fault'
I have installed memcached fine, and now I will need to install PECL extension memcache. Im running RedHat x86_64 es5. The installation gives me this: downloading memcache-2.2.6.tgz ... Starting to download memcache-2.2.6.tgz (35,957 bytes) ..........done: 35,957 bytes 11 source files, building running:… >>> More