Discussion :

[laurentSc]

Bonsoir,

je souhaite utiliser cet outil pour générer une documentation de mon code (l'outil est proche de Javadoc et mon principal interlocuteur est issu du monde Java). Mon souci est d'effectuer l'installation de l'outil. Si je me tourne vers le lien fourni par DVP, il ne marche plus. Si je fais une recherche sur le net :
- c'est soi-disant très simple si on a PEAR : je ne l'ai pas.
- installation avec un PHAR : j'ai bien téléchargé le fichier PHAR mais je ne sais aller plus loin.
- installation manuelle : j'y arrive pas non plus.

bref,

[Celira]

D'après la doc de PHPDocumentor (je suppose que c'est de cet outil que tu parles)

To do a manual installation, follow these steps

Locate the latest release on the releases page for phpDocumentor2 on GitHub
Download the attached tarball (not the source code!)
Extract the downloaded tarball into your destination directory.

After you have done the above can the executable be found at bin/phpdoc.php in the installation directory.

https://www.phpdoc.org/
Donc en bref : on télécharge, on dé-compresse et on lance le fichier php. Qu'est-ce qui est compliqué là-dedans ?
A priori, la dernière version stable est la 2.9.0 https://github.com/phpDocumentor/php...ses/tag/v2.9.0

[laurentSc]

Je viens de récupérer phpdoc.php version 2.9.0 sur Github https://github.com/phpDocumentor/php...or/tree/v2.9.0.
L'exécution de ce fichier donne un message d'erreur, ce qui n'est pas surprenant :

Code php :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
 
#!/usr/bin/env php
<?php
/**
 * phpDocumentor
 *
 * PHP Version 5.3
 *
 * @copyright 2010-2013 Mike van Riel / Naenius (http://www.naenius.com)
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
 * @link      http://phpdoc.org
 */
 
trigger_error('phpDocumentor2 should be run from the phpdoc file, not phpdoc.php', E_USER_DEPRECATED);
require_once __DIR__.'/phpdoc';

[grunk]

Il ne faut pas executer le fichier /bin/phpdoc.php mais /bin/phpdoc

Comme bien souvent tu veux aller plus vite que la musique et tu ne lit pas les instructions qui sont pourtant simples :/

Le plus simple reste quand même d'utiliser le .phar puisqu'il suffit de l'executer avec PHP sans se soucier de rien.

Note quand même que y'a des chances que ca ne marche pas en PHP 7 à cause des dépendance assez anciennes qui veulent du PHP 5.3. Il faut alors passer sur la branch master et non la release 2.9.0

[laurentSc]

Les instructions, je les vois pas...

Si je tente d'exécuter bin/phpdoc

comment voulez vous ouvrir ce fichier ? etc

Si je tente de lancer phpdoc.bat, ça plante pas, mais il rend la main immédiatement et il ne se passe rien...

[grunk]

Pour executer bin/phpdoc , il ne faut évidemment pas double cliquer dessus ... On est sur application php ici.
Donc en ligne de commande php bin/phpdoc

[laurentSc]

J'ai tapé php bin/phpdoc en ligne de commande (si je le tape dans la barre de recherche (windows 10, en bas de l'écran à gauche)), ça me propose "exécuter la commande"). Mais si je clique, ça a l'air de lancer un truc (bref flash) mais il ne se passe rien...

[rawsrc]

est-ce que WAMP déclare php.exe dans la variable d'environnement PATH de windows ?

[laurentSc]

Et non, donc je l'ai rajouté :

PHP c:\wamp64\bin\php\php7.3.5

Ensuite, en invite de commandes, je me suis rendu dans le répertoire qui contient le répertoire bin de phpdoc et j'ai tapé PHP bin/phpdoc.
Résultat :

Fatal error: Uncaught RuntimeException: phpDocumentor expected to find an autoloader at "C:\wamp64\www\phpdoc\phpDocumentor-2.9.0\phpDocumentor-2.9.0\src\phpDocumentor/../../vendor/autoload.php" but it was not there. Usually this is because the "composer install" command has not been ran yet. If this is not the case, please open an issue at http://github.com/phpDocumentor/phpDocumentor2 detailing what installation method you used, which path is mentioned in this error message and any other relevant information. in C:\wamp64\www\phpdoc\phpDocumentor-2.9.0\phpDocumentor-2.9.0\src\phpDocumentor\Bootstrap.php:101 Stack trace: #0 C:\wamp64\www\phpdoc\phpDocumentor-2.9.0\phpDocumentor-2.9.0\src\phpDocumentor\Bootstrap.php(60): phpDocumentor\Bootstrap->createAutoloader('C:\\wamp64\\www\\p...') #1 C:\wamp64\www\phpdoc\phpDocumentor-2.9.0\phpDocumentor-2.9.0\bin\phpdoc(23): phpDocumentor\Bootstrap->initialize() #2 {main} thrown in C:\wamp64\www\phpdoc\phpDocumentor-2.9.0\phpDocumentor-2.9.0\src\phpDocumentor\Bootstrap.php on line 101

Que faire ?

[grunk]

La réponse est dans l'erreur (comme 99% du temps) :

Usually this is because the "composer install" command has not been ran yet

Il faut donc lancer un composer install à la racine du projet pour l'initialiser.

[laurentSc]

OK mais à la racine de phpdoc (qui contient le dossier phpDocumentor-2.9.0)

composer install
'composer' n’est pas reconnu en tant que commande interne
ou externe, un programme exécutable ou un fichier de commandes.