From 1b973ad6f2984bafd82d2e5706c6244765f58be0 Mon Sep 17 00:00:00 2001
From: amemo <amemo@rezo.net>
Date: Thu, 14 Nov 2013 22:02:14 +0000
Subject: [PATCH] =?UTF-8?q?Documentation=20du=20code=20:=20-=20spip=5Flog?=
 =?UTF-8?q?=20(par=20Peetdu)=20:=C2=A0Ajouter=20les=20intitul=C3=A9s=20des?=
 =?UTF-8?q?=20niveaux=20de=20log?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Relecteur : Matthieu Marcillaud
---
 ecrire/inc/utils.php | 21 ++++++++++++++++-----
 1 file changed, 16 insertions(+), 5 deletions(-)

diff --git a/ecrire/inc/utils.php b/ecrire/inc/utils.php
index 6032354d0b..31a73de19f 100644
--- a/ecrire/inc/utils.php
+++ b/ecrire/inc/utils.php
@@ -228,16 +228,27 @@ function pipeline($action, $val=null) {
  *
  * Le niveau de log par défaut est la valeur de la constante `_LOG_INFO`
  * 
+ * Les différents niveaux possibles sont :
+ *
+ * - `_LOG_HS` : écrira 'HS' au début de la ligne logguée
+ * - `_LOG_ALERTE_ROUGE` : 'ALERTE'
+ * - `_LOG_CRITIQUE` :  'CRITIQUE'
+ * - `_LOG_ERREUR` : 'ERREUR'
+ * - `_LOG_AVERTISSEMENT` : 'WARNING'
+ * - `_LOG_INFO_IMPORTANTE` : '!INFO'
+ * - `_LOG_INFO` : 'info'
+ * - `_LOG_DEBUG` : 'debug'
+ *
  * @example
  *   ```
  *   spip_log($message)
- *   spip_log($message,'recherche')
- *   spip_log($message,_LOG_DEBUG)
- *   spip_log($message,'recherche.'._LOG_DEBUG)
+ *   spip_log($message, 'recherche')
+ *   spip_log($message, _LOG_DEBUG)
+ *   spip_log($message, 'recherche.'._LOG_DEBUG)
  *   ```
  *
  * @api
- * @link http://doc.spip.org/@spip_log
+ * @link http://programmer.spip.net/spip_log
  * @uses inc_log_dist()
  *
  * @param string $message
@@ -248,7 +259,7 @@ function pipeline($action, $val=null) {
  *     - string indique le type de log
  *     - `string.int` indique les 2 éléments.
  *     Cette dernière notation est controversée mais le 3ème
- *     paramètre est planté pour cause de compat ascendante.
+ *     paramètre est planté pour cause de compatibilité ascendante.
  */
 function spip_log($message=NULL, $name=NULL) {
 	static $pre = array();
-- 
GitLab