INSTALLATION de PHPDocumentor ============================= Dépendences du serveur : ------------------------ php5-intl graphviz Optionnellement (pour anciens templates xsl) : php5-xsl Installation : -------------- svn co svn://zone.spip.org/spip-zone/_galaxie_/code.spip.net/autodoc/trunk autodoc && cd autodoc curl -sS https://getcomposer.org/installer | php php composer.phar install cd .. En fonction de l'usage et du contenu de phpdoc.xml, il faudra créer un/des répertoires avec accès en écriture. * Avec l'application `autodoc/bin/autodoc_helper` : mkdir work * Avec l'executable `autodoc/bin/autodoc` (et en fonction du phpdoc.xml) : mkdir output && mkdir log Mises à jour : -------------- cd autodoc && svn up php composer.phar self-update php composer.phar update cd .. Notes sur les mises à jour: --------------------------- J'ai aperçu que phpDocumentor copie les fichiers du template utilisé dans son propre répertoire de templates. Il arrive que de vieux fichiers trainent. Il faut donc supprimer `autodoc/vendor/phpdocumentor/templates/zora` qui se recréera. USAGE ===== Il y a deux exécutables disponibles. * L'un `autodoc` est l'équivalent de l'exécutable de phpdocumentor mais charge en plus le plugins SPIP pour phpdocumentor. * L'autre `autodoc_helper` est une application simplifiant l'utilisation en préconfigurant les commandes à transmettre à l'exécutable. Elle gère également le téléchargement des sources PHP à documenter. Exécutable autodoc.php ---------------------- Appel : autodoc/bin/autodoc Le fonctionnement est exactement le même que le script `phpdoc` https://www.phpdoc.org/docs/latest/for-users/basic-usage.html L'exécutable sans paramètre affiche la liste des actions et peut afficher, pour chaque action ses arguments et options possibles. ### Appeler le template `zora` Par commande : autodoc/bin/autodoc --template=autodoc/templates/zora Par configuration : autodoc/bin/autodoc -c phpdoc.xml Dans le fichier de configuration : [...]