Mettre à jour la documentation du code source
Un article de LodelWiki.
La documentation du code source de Lodel est générée via l'utilitaire PHPDocumentor. Il est nécessaire de la mettre à jour à un rythme régulier pour qu'elle reflète les ajouts et modifications dans le code.
Voici comment mettre à jour cette documentation :
[modifier] Prérequis
- Phpdoc installé via PEAR (pourquoi ? parce que c'est plus simple!)
/usr/bin/pear install phpdocumentor
- un bac à sable à jour (un ptit cvs checkout).
- le script generephpdoc.sh (qui a été ajouté au CVS dans le répertoire lodel/install)
[modifier] Lancement du script generephpdoc.sh
Se placer dans le répertoire lodel/install de son bac à sable
./generephpdoc.sh
Il est possible de rencontrer une erreur de mémoire avec PHP. Dans ce cas éditer le script et modifier la variable PATH_PROJECT et ne mettre qu'un répertoire à la fois.
Une fois la documentation terminée avec succès, copier le répertoire docs qui a été créé vers le répertoire doccodesource sur le serveur de lodel.org. Ou informer l'admin du site que vous avez mis à jour la documentation.
