Apportez votre aide…
PhpDocumentor
Présentation
PhpDocumentor permet de générer la documentation des codes sources PHP.
Installation
Via Pear
Installation de Pear
sudo apt-get install pear
Conseil, installez également le paquet apt://php5-dev
sudo apt-get install php5-dev
On peut maintenant passer à l'installation de apt://php-pear
sudo apt-get install php-pear
Installation de PhpDocumentor
Avant l'installation de PhpDocumentor il faut indiquer à Pear où installer le contenu, sous Ubuntu, apache recherche du contenu web dans le dossier /var/www par défaut, nous allons donc donner cette indication à Pear :
sudo pear config-set data_dir /var/www
Installation de PhpDocumentor à proprement parler :
sudo pear install --alldeps PhpDocumentor
Post installation : réglages finaux
Nous allons indiquer l'emplacement par défaut des documents générés par PhpDocumentor. Comme la plupart, vous souhaiterez générer cette documentation au format HTML, il est donc judicieux de définir cet emplacement dans /var/www également, créons donc ce répertoire
sudo mkdir /var/www/PhpDocOut
Donnons les droits d'accès à ce répertoire à Apache, en définissant www-data comme le propriétaire de celui-ci :
sudo chown www-data /var/www/PhpDocOut
L'installation est maintenant terminée.
Utilisation
Rendez-vous sur l'adresse suivante : http://127.0.0.1/PhpDocumentor, vous devriez accéder à l'interface de PhpDocumentor (cela permet de vérifier l'installation d'une certaine façon )
Pour le mode d'emploi et son utilisation, je vous invite à consulter le site Officiel, car ce n'est pas le but premier de cette documentation .
Voir aussi
- Site officiel : http://www.phpdoc.org/
- Le site de Pear : http://pear.php.net/
Autre références (en)
- PhpDocumentor Wikipedia EN (La version FR étant très1) légère)
Sources
Contributeurs : chtiland.