465 |
jpm |
1 |
#!/bin/bash
|
|
|
2 |
########################################################################################################################
|
|
|
3 |
# But : création de la doc ApiGen du Framework.
|
|
|
4 |
# Auteur : Jean-Pascal Milcent <jpm@tela-botanica.org>
|
|
|
5 |
# License : GPL v3
|
|
|
6 |
# Création : 12 mars 2014
|
|
|
7 |
# Version: 2
|
|
|
8 |
# Exemple : ./genererApiGen.sh -t "Mon Titre"
|
|
|
9 |
########################################################################################################################
|
|
|
10 |
# Constante
|
|
|
11 |
TITRE=""
|
|
|
12 |
SOURCE="./../framework"
|
|
|
13 |
CIBLE="./ApiGen"
|
|
|
14 |
IGNORER=".htaccess,config.ini"
|
|
|
15 |
FORMAT="clean"
|
|
|
16 |
|
|
|
17 |
# Aide
|
|
|
18 |
E_OPTERR=65
|
|
|
19 |
if [ "$1" = '--help' ]
|
|
|
20 |
then # Le script a besoin d'au moins un argument sur la ligne de commande
|
|
|
21 |
echo "Usage $0 -[parameters -t ]"
|
|
|
22 |
echo "Paramétres : "
|
|
|
23 |
echo " -t: indiquer le titre de la doc"
|
|
|
24 |
exit $E_OPTERR
|
|
|
25 |
fi
|
|
|
26 |
|
|
|
27 |
# Récupération des paramètres et des options de la ligne de commande
|
|
|
28 |
TEMP=`getopt -o t: -l help: -- "$@"`
|
|
|
29 |
if [ $? != 0 ] ; then echo "Terminating..." >&2 ; exit 1 ; fi
|
|
|
30 |
eval set -- "$TEMP"
|
|
|
31 |
while [ ! -z "$1" ] ; do
|
|
|
32 |
#echo $1" # "$2
|
|
|
33 |
case "$1" in
|
|
|
34 |
-t) TITRE=$2;;
|
|
|
35 |
--) shift ; break ;;
|
|
|
36 |
*) echo "Internal error!" ; exit 1 ;;
|
|
|
37 |
esac
|
|
|
38 |
shift 2
|
|
|
39 |
done
|
|
|
40 |
|
|
|
41 |
# Suppression des dossiers précédent de la doc
|
|
|
42 |
if [ -d PhpDoc ]; then
|
|
|
43 |
rm -fR ApiGen
|
|
|
44 |
mkdir ApiGen
|
|
|
45 |
fi;
|
|
|
46 |
|
|
|
47 |
echo "Génération de la documentation :";
|
|
|
48 |
/opt/lampp/bin/php /opt/lampp/bin/apigen --source "$SOURCE" --destination "$CIBLE" --title "$TITRE" \
|
|
|
49 |
--charset UTF-8 \
|
|
|
50 |
--exclude "*/doc/*" \
|
|
|
51 |
--exclude "*/exemple/*" \
|
|
|
52 |
--exclude "*/test/*" \
|
|
|
53 |
--access-levels "public,protected" \
|
|
|
54 |
--internal "no" \
|
|
|
55 |
--php "yes" \
|
|
|
56 |
--tree "yes" \
|
|
|
57 |
--deprecated "yes" \
|
|
|
58 |
--todo "yes" \
|
|
|
59 |
--download "no" \
|
|
|
60 |
--source-code "yes" \
|
|
|
61 |
--colors "yes" \
|
|
|
62 |
--update-check "no"
|