From 483a74ca3a44f65de4f73d89793d32340f687aa4 Mon Sep 17 00:00:00 2001
From: "marcimat@rezo.net" <>
Date: Wed, 13 Feb 2013 18:51:42 +0000
Subject: [PATCH] Corrections de PHPDoc

---
 base/medias.php               | 19 ++++++++++++-------
 inc/choisir_mode_document.php | 20 ++++++++++++++------
 medias_fonctions.php          | 12 ++++++------
 3 files changed, 32 insertions(+), 19 deletions(-)

diff --git a/base/medias.php b/base/medias.php
index 8090501f..30354f1d 100644
--- a/base/medias.php
+++ b/base/medias.php
@@ -10,10 +10,16 @@
  *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
 \***************************************************************************/
 
+/**
+ * Déclarations relatives à la base de données
+ *
+ * @package SPIP\Medias\Pipelines
+**/
+
 if (!defined('_ECRIRE_INC_VERSION')) return;
 
 /**
- * Interfaces des tables breves pour le compilateur
+ * Interfaces des tables documents pour le compilateur
  *
  * @param array $interfaces
  * @return array
@@ -183,9 +189,8 @@ function medias_declarer_tables_objets_sql($tables){
 /**
  * Creer la table des types de document
  *
- * http://doc.spip.org/@creer_base_types_doc
- *
  * @param string $serveur
+ * @param string $champ_media
  * @return void
  */
 function creer_base_types_doc($serveur='', $champ_media="media_defaut") {
@@ -260,10 +265,10 @@ function creer_base_types_doc($serveur='', $champ_media="media_defaut") {
 
 
 /**
- * Optimiser la base de donnee en supprimant les liens orphelins
+ * Optimiser la base de données en supprimant les liens orphelins
  *
- * @param int $n
- * @return int
+ * @param array $flux
+ * @return array
  */
 function medias_optimiser_base_disparus($flux){
 
@@ -277,4 +282,4 @@ function medias_optimiser_base_disparus($flux){
 	return $flux;
 }
 
-?>
\ No newline at end of file
+?>
diff --git a/inc/choisir_mode_document.php b/inc/choisir_mode_document.php
index 3ed61346..2220278e 100644
--- a/inc/choisir_mode_document.php
+++ b/inc/choisir_mode_document.php
@@ -10,16 +10,24 @@
  *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
 \***************************************************************************/
 
+/**
+ * Gestion des modes de documents
+ *
+ * @package SPIP\Medias\Modes
+ */
 if (!defined("_ECRIRE_INC_VERSION")) return;
 
 /**
  * Choisir le mode du document : image/document
- * fonction surchargeable
  *
- * @param unknown_type $fichier
- * @param unknown_type $type_image
- * @param unknown_type $largeur
- * @param unknown_type $hauteur
+ * @param array $infos
+ *     Informations sur le document (en base + prises sur le fichier)
+ * @param bool $type_image
+ *     Type d'inclusion demandée : true si image
+ * @param string $objet
+ *     Objet sur lequel est placé le document
+ * @return string
+ *     Mode du document
  */
 function inc_choisir_mode_document($infos, $type_inclus_image, $objet){
 	
@@ -51,4 +59,4 @@ function inc_choisir_mode_document($infos, $type_inclus_image, $objet){
 		return 'document';
 }
 
-?>
\ No newline at end of file
+?>
diff --git a/medias_fonctions.php b/medias_fonctions.php
index b3c180cc..56583cfd 100644
--- a/medias_fonctions.php
+++ b/medias_fonctions.php
@@ -24,12 +24,12 @@ if (!defined('_ECRIRE_INC_VERSION')) return;
 /**
  * Afficher la puce de statut pour les documents
  *
- * @param unknown_type $id_document
- * @param unknown_type $statut
- * @param unknown_type $id_rubrique
- * @param unknown_type $type
- * @param unknown_type $ajax
- * @return unknown
+ * @param int $id_document
+ *     Identifiant du document
+ * @param string $statut
+ *     Statut du document
+ * @return string
+ *     Code HTML de l'image de puce
  */
 function medias_puce_statut_document($id_document, $statut){
 	if ($statut=='publie') {
-- 
GitLab