From 32083229ba7eddaa8a38c94f34a87919b850fb97 Mon Sep 17 00:00:00 2001 From: Michael RICOIS Date: Fri, 3 Aug 2012 19:23:35 +0000 Subject: [PATCH] Ajout documentation --- docs/README.txt | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/README.txt b/docs/README.txt index df5d9f39..f0c05215 100644 --- a/docs/README.txt +++ b/docs/README.txt @@ -48,6 +48,26 @@ retrouve visible dans le service (wsdl, requête) Si des fonctions ne doivent pas être rendu visible il faut donc les séparer dans un autre controller utilisant une autre class. + +Documentation des méthodes et ajout spécial +=========================================== + +La documentation est géneré en automatique. + +Voici comment définir simplement la documentation d'une méthode + + /** + * Retourne les informations identitaires de l'entreprise ou de l'établissement demandé + * @param string $key Siren de l'entreprise ou siret de l'établissement + * @return Identite + */ + public function test($key) + { + + } + +Attention ces informations servent aussi pour la structure du WSDL + Pour spécifier un lien vers un fichier ou pour générer un fichier depuis une requête SQL à partir de la documentation du service. Ajouter dans le docblock : @@ -59,6 +79,10 @@ Ajouter dans le docblock : Les fichiers a télécharger sont à placer dans le répértoire public/fichier et les fichiers sql dans public/sql +Pour spécifier des éléments de taille (non pris en compte sur le WSDL) + @xsd minLength=9 + @xsd maxLength=15 + Configuration PHP =================