Retour : page principale > sommaire applications générales > Base de code standard
Utiliser le en ligne de commande : ./genererApiGen.sh -t "titre de la doc"
Utiliser le en ligne de commande : ./genererPhpDoc.sh -t "titre de la doc"
Utiliser le en ligne de commande : ./envoyerDoc.sh -h 193.54.123.169 -u telabotaa -p mot_de_passe -v "version_du_framework"
Pour cela suivez les Ă©tapes ci-dessous :
Comment ajouter à SVN la gestion des propriétés (keywords ou tags)
Se placer sur le dossier principale d'un dossier dans Eclipse. Clic droit : Team > set Properties. Dans la fenĂŞtre :
Comment générer la documentation phpDoc du TBFramework
Avant de générer la doc
Installer "phpdoc" et "apigen" :- se rendre en root dans /opt/lampp/bin
- Installer avec pear les deux générateurs de doc :
- Activer la découverte auto des nouveaux dépôts : pear config-set auto_discover 1
- Installer ApiGen : pear install pear.apigen.org/apigen
- Ajouter le dépôt PhpDocumentor : pear channel-discover pear.phpdoc.org
- Installer PhpDocumentor : pear install phpdoc/phpDocumentor
Pour générer la doc ApiGen
Sur le dépôt dans le dossier "doc" se trouve le script shell (Linux) genererApiGen.sh.Utiliser le en ligne de commande : ./genererApiGen.sh -t "titre de la doc"
Pour générer la doc PhpDoc
Sur le dépôt dans le dossier "doc" se trouve le script shell (Linux) genererPhpDoc.sh.Utiliser le en ligne de commande : ./genererPhpDoc.sh -t "titre de la doc"
Pour envoyer la doc sur l'intranet
Sur le dépôt dans le dossier "doc" se trouve le script shell (Linux) envoyerDoc.sh.Utiliser le en ligne de commande : ./envoyerDoc.sh -h 193.54.123.169 -u telabotaa -p mot_de_passe -v "version_du_framework"
Archives
Prise en compte des mots-clés SVN
Assurez vous d'avoir bien commité l'ensemble des fichiers du framework avec la prise en compte de la gestion des mots clés SVN.Pour cela suivez les étapes ci-dessous :
Comment ajouter à SVN la gestion des propriétés (keywords ou tags)
Se placer sur le dossier principale d'un dossier dans Eclipse. Clic droit : Team > set Properties. Dans la fenĂŞtre :
- mettre svn:keywords dans le champ "Property name",
- dans "Enter a text property" mettre : Id Author Date Revision HeadURL
- cocher "Set property recursively"
- commiter les fichiers