From 493d929aaf04c01cfd59f54e8b2e4a33b59c838e Mon Sep 17 00:00:00 2001
From: amemo <amemo@rezo.net>
Date: Sun, 8 Nov 2015 20:25:42 +0000
Subject: [PATCH] =?UTF-8?q?Documentation=20du=20code=20:=20-=20objet=5Fdis?=
 =?UTF-8?q?socier=20(par=20pierretux)=20:=C2=A0Meilleurs=20visibilit=C3=A9?=
 =?UTF-8?q?=20et=20accents=20-=20url=5Fde=5Fbase=20(par=20pierretux)=20:?=
 =?UTF-8?q?=C2=A0ortographe?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Relecteur : Matthieu Marcillaud
---
 ecrire/action/editer_liens.php |  8 ++++----
 ecrire/inc/utils.php           | 25 ++++++++++++++-----------
 2 files changed, 18 insertions(+), 15 deletions(-)

diff --git a/ecrire/action/editer_liens.php b/ecrire/action/editer_liens.php
index 16d168557e..be2b2cea82 100644
--- a/ecrire/action/editer_liens.php
+++ b/ecrire/action/editer_liens.php
@@ -94,15 +94,15 @@ function objet_associer($objets_source, $objets_lies, $qualif = null){
 /**
  * Dissocier un (ou des) objet(s)  des objets listés
  * 
- * $objets_source et $objets sont de la forme
- * array($objet=>$id_objets,...)
- * $id_objets peut lui meme etre un scalaire ou un tableau pour une liste d'objets du meme type
+ * `$objets_source` et `$objets_lies` sont de la forme
+ * `array($objet=>$id_objets,...)`
+ * `$id_objets` peut lui-même être un scalaire ou un tableau pour une liste d'objets du même type
  *
  * Les objets sources sont les pivots qui portent les liens
  * et pour lesquels une table spip_xxx_liens existe
  * (auteurs, documents, mots)
  *
- * un * pour $objet,$id_objet permet de traiter par lot
+ * un * pour $objet, $id_objet permet de traiter par lot
  * seul le type de l'objet source ne peut pas accepter de joker et doit etre explicite
  *
  * S'il y a des rôles possibles entre les 2 objets, et qu'aucune condition
diff --git a/ecrire/inc/utils.php b/ecrire/inc/utils.php
index b4734478eb..e05d95a512 100644
--- a/ecrire/inc/utils.php
+++ b/ecrire/inc/utils.php
@@ -1513,19 +1513,22 @@ function test_valeur_serveur($truc) {
 // Fonctions de fabrication des URL des scripts de Spip
 //
 /**
- * l'URL de base du site, sans se fier a meta(adresse_site) qui
- * peut etre fausse (sites a plusieurs noms d'hotes, deplacements, erreurs)
- * Note : la globale $profondeur_url doit etre initialisee de maniere a
- * indiquer le nombre de sous-repertoires de l'url courante par rapport a la
- * racine de SPIP : par exemple, sur ecrire/ elle vaut 1, sur sedna/ 1, et a
- * la racine 0. Sur url/perso/ elle vaut 2
- * http://code.spip.net/@url_de_base
+ * Calcule l'url de base du site
+ *
+ * Calcule l'URL de base du site, sans se fier à la méta (adresse_site) qui
+ * peut être fausse (sites avec plusieurs noms d’hôtes, déplacements, erreurs)
+ * 
+ * @note
+ *     La globale `$profondeur_url` doit être initialisée de manière à
+ *     indiquer le nombre de sous-répertoires de l'url courante par rapport à la
+ *     racine de SPIP : par exemple, sur ecrire/ elle vaut 1, sur sedna/ 1, et à
+ *     la racine 0. Sur url/perso/ elle vaut 2
  *
  * @param int|boo|array $profondeur
- *    si non renseignee : retourne l'url pour la profondeur $GLOBALS['profondeur_url']
- *    si int : indique que l'on veut l'url pour la prondeur indiquee
- *    si bool : retourne le tableau static complet
- *    si array : reinitialise le tableau static complet avec la valeur fournie
+ *    - si non renseignée : retourne l'url pour la profondeur $GLOBALS['profondeur_url']
+ *    - si int : indique que l'on veut l'url pour la profondeur indiquée
+ *    - si bool : retourne le tableau static complet
+ *    - si array : réinitialise le tableau static complet avec la valeur fournie
  * @return string|array
  */
 function url_de_base($profondeur=null) {
-- 
GitLab