Gnration
de
la
documentation
..................................................................................................
5
Informations
sur
le
document
Projet ANR
ANR Contint - ANR-10-CORD-009
Nom du projet
Datalift
Nom complet
Un ascenseur pour les donnes
URL du projet
www.datalift.org
Lot
Numro
WP5
Titre
Architecture and integration
Tche
Numro
T5.1
Titre
Platform architecture
Dlivrable
Numro
D5.4
Titre
API Documentation
Date de livraison
Contractuelle
M18 M24 M36
Actuelle
Statut
Prliminaire Final
Nature
Prototype Rapport Dissmination
Niveau de dissmination
Public Interne au consortium
06.06.2012
Rdacteurs
Laurent Bihanic (Atos) Ocane Ventura (Atos)
Resp. de la rdaction
Nom
Laurent Bihanic
Partenaire
AtoS
Rsum
Ce document est dcrit le moyen daccder la documentation des API
de la plateforme Datalift.
Mots cls
Documentation, API, Java, Javadoc, Plateforme
Mail
Versions Date
Rv.
Auteur
Dtail
06/06/2012
1.0
Laurent Bihanic
Version initiale
laurent.bihanic@atos.net
Error!
Style
not
defined.
1. Introduction Le prsent document constitue le livrable D5.4 des tches T5.1du lot 5 (WP5). Sous le titre API Documentation , cette tche est consacre dcrire le moyen daccder la documentation de lAPI de la plateforme Datalift. On retrouve ces informations dans le Wiki du projet.
Error!
Style
not
defined.
2. Gnration de la documentation La gnration de la documentation de la plateforme Datalift seffectue grce loutil Javadoc. Il permet de crer une documentation HTML partir des commentaires prsents dans le code source de la plateforme Datalift. Afin de faciliter le lancement de cet outil, il est possible de lancer une commande ANT paramtre en utilisant les sources du projet. ANT est un outil permettant lautomatisation de tches en Java. Pour installer ANT sur Windows : 1. Aller sur le site du projet ANT : http://ant.apache.org/bindownload.cgi 2. Tlcharger la dernire version dAnt en .zip 3. Placer le contenu de larchive dans un rpertoire de votre dossier C:\ 4. Ajouter le chemin du dossier ant/bin la variable denvironnement PATH de votre poste 5. Ajouter le chemin du dossier ant la variable denvironnement ANT_HOME 6. Ajouter la variable denvironnement ANT_HOME ayant pour valeur -Xmx256M Rappel : Ppour modifier vos variables denvironnement sous Windows, allez dans Dmarrer/Ordinateur/Proprits, Modifier les paramtres, Paramtres systmes avancs, Variables denvironnement. Pour gnrer la Javadoc de Datalift avec ANT : 1. Placez-vous dans le dossier Datalift contenant les sources du projet 2. Lancez la commande : ant javadoc 3. Un dossier javadoc est gnr dans le dossier Datalift contenant la documentation au format HTML Vous pouvez galement lancer cette tche ant grce au plugin Eclipse correspondant sans installer au pralable ANT sur votre poste. Aperu de la javadoc gnre :
