Remerciez-le!

Remerciez @Admin pour avoir partagé cet document gratuitement, de la manière la plus simple, en partageant sur les réseaux sociaux.

Report on API documentation - Laurent BIHANIC Author Laurent BIHANIC Reviewer G

Report on API documentation - Laurent BIHANIC Author Laurent BIHANIC Reviewer Gabriel KEPEKLIAN Title API Documentation Date 6 juin 2012 Reference D5.4 Version 1.0 Destination Consortium members only FROM RAW PUBLISHED DATA TO INTERLINKED SEMANTIC DATA PROJET DATALIFT De la donnée brute publiée à la donnée sémantique interconnectée Appel ANR CONTINT 2010 ANR-10-CORD-009 RAPPORT DE RECHERCHE Datalift -‐ Deliverable 5.4 2 Sommaire 1. Introduction .................................................................................................................................. 4 2. Génération de la documentation .................................................................................................. 5 3 Informations sur le document Projet ANR ANR Contint - ANR-10-CORD-009 Nom du projet Datalift Nom complet Un ascenseur pour les données URL du projet www.datalift.org Lot Numéro WP5 Titre Architecture and integration Tâche Numéro T5.1 Titre Platform architecture Délivrable Numéro D5.4 Titre API Documentation Date de livraison Contractuelle M18 M24 M36 Actuelle 06.06.2012 Statut Préliminaire Final Nature Prototype Rapport Dissémination Niveau de dissémination Public Interne au consortium Rédacteurs Laurent Bihanic (Atos) – Océane Ventura (Atos) Resp. de la rédaction Nom Laurent Bihanic Mail laurent.bihanic@atos.net Partenaire AtoS Résumé Ce document est décrit le moyen d’accéder à la documentation des API de la plateforme Datalift. Mots clés Documentation, API, Java, Javadoc, Plateforme Versions Date Rév. Auteur Détail 06/06/2012 1.0 Laurent Bihanic Version initiale Error! Style not defined. 4 1. Introduction Le présent document constitue le livrable D5.4 des tâches T5.1du lot 5 (WP5). Sous le titre « API Documentation », cette tâche est consacrée à décrire le moyen d’accéder à la documentation de l’API de la plateforme Datalift. On retrouve ces informations dans le Wiki du projet. Error! Style not defined. 5 2. Génération de la documentation La génération de la documentation de la plateforme Datalift s’effectue grâce à l’outil Javadoc. Il permet de créer une documentation HTML à partir des commentaires présents dans le code source de la plateforme Datalift. Afin de faciliter le lancement de cet outil, il est possible de lancer une commande ANT paramétrée en utilisant les sources du projet. ANT est un outil permettant l’automatisation de tâches en Java. Pour installer ANT sur Windows : 1. Aller sur le site du projet ANT : http://ant.apache.org/bindownload.cgi 2. Télécharger la dernière version d’Ant en .zip 3. Placer le contenu de l’archive dans un répertoire de votre dossier C:\ 4. Ajouter le chemin du dossier ant/bin à la variable d’environnement PATH de votre poste 5. Ajouter le chemin du dossier ant à la variable d’environnement ANT_HOME 6. Ajouter la variable d’environnement ANT_HOME ayant pour valeur -Xmx256M Rappel : Ppour modifier vos variables d’environnement sous Windows, allez dans Démarrer/Ordinateur/Propriétés, Modifier les paramètres, Paramètres systèmes avancés, Variables d’environnement. Pour générer 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 généré dans le dossier Datalift contenant la documentation au format HTML Vous pouvez également lancer cette tâche ant grâce au plugin Eclipse correspondant sans installer au préalable ANT sur votre poste. Aperçu de la javadoc générée : Datalift -‐ Deliverable 5.4 6 uploads/s1/ d5-4-api-documentation-v1-0.pdf