Quelques phpdoc

ecrire/inc/lang.php

@@ -210,6 +210,7 @@ function select_langues($nom_select, $change, $options, $label="")
  * @param string $nom_select
  *     Attribut name du select
  *     Selon son nom, retourne une liste différente :
+ * 
  *     - var_lang ou changer_lang :
  *         liste des langues sélectionnées dans la config multilinguisme
  *     - var_lang_ecrire :

ecrire/inc/prepare_recherche.php

@@ -10,6 +10,11 @@
  *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
 \***************************************************************************/
 
+/**
+ * Gestion des préparatifs de recherches
+ *
+ * @package SPIP\Core\Recherche
+**/
 
 if (!defined('_ECRIRE_INC_VERSION')) return;
 
@@ -17,12 +22,11 @@ include_spip('inc/rechercher');
 if (!defined('_DELAI_CACHE_resultats')) define('_DELAI_CACHE_resultats', 600);
 
 /**
- * Preparer les listes id_article IN (...) pour les parties WHERE
- * et points =  des requetes du moteur de recherche
- * http://doc.spip.org/@inc_prepare_recherche_dist
+ * Préparer les listes `id_article IN (...)` pour les parties WHERE
+ * et calcul des `points` pour la partie SELECT des requêtes du moteur de recherche
  * 
- * Le parametre $serveur est utilise pour savoir sur quelle base on cherche
- * mais l'index des resultats est toujours stock� sur le serveur principal
+ * Le paramètre $serveur est utilisé pour savoir sur quelle base on cherche
+ * mais l'index des résultats est toujours stocké sur le serveur principal
  * car on ne sait pas si la base distante dispose d'une table spip_resultats
  * ni meme si on aurait le droit d'ecrire dedans
  *

ecrire/inc/rechercher.php

@@ -10,6 +10,11 @@
  *  Pour plus de details voir le fichier COPYING.txt ou l'aide en ligne.   *
 \***************************************************************************/
 
+/**
+ * Gestion des recherches
+ *
+ * @package SPIP\Core\Recherche
+**/
 
 if (!defined('_ECRIRE_INC_VERSION')) return;
 

ecrire/public/balises.php

@@ -527,13 +527,43 @@ function balise_TOTAL_BOUCLE_dist($p) {
 	return $p;
 }
 
-// Si on est hors d'une boucle {recherche}, ne pas "prendre" cette balise
-// http://doc.spip.org/@balise_POINTS_dist
+
+/**
+ * Compile la balise `#POINTS` qui affiche la pertinence des résultats
+ *
+ * Retourne le calcul `points` réalisé par le critère `recherche`.
+ * Cette balise nécessite donc la présence de ce critère.
+ * 
+ * @balise POINTS
+ * @link http://www.spip.net/903 Boucles et balises de recherche
+ * @see critere_recherche_dist()
+ * 
+ * @param Champ $p
+ *     Pile au niveau de la balise
+ * @return Champ
+ *     Pile complétée par le code à générer
+**/
 function balise_POINTS_dist($p) {
 	return rindex_pile($p, 'points', 'recherche');
 }
 
-// http://doc.spip.org/@balise_POPULARITE_ABSOLUE_dist
+
+/**
+ * Compile la balise `#POPULARITE_ABSOLUE` qui affiche la popularité absolue
+ *
+ * Cela correspond à la popularité quotidienne de l'article
+ * 
+ * @balise POPULARITE_ABSOLUE
+ * @link http://www.spip.net/1846 La popularité
+ * @see balise_POPULARITE_dist()
+ * @see balise_POPULARITE_MAX_dist()
+ * @see balise_POPULARITE_SITE_dist()
+ * 
+ * @param Champ $p
+ *     Pile au niveau de la balise
+ * @return Champ
+ *     Pile complétée par le code à générer
+**/
 function balise_POPULARITE_ABSOLUE_dist($p) {
 	$p->code = 'ceil(' .
 	champ_sql('popularite', $p) .
@@ -542,14 +572,45 @@ function balise_POPULARITE_ABSOLUE_dist($p) {
 	return $p;
 }
 
-// http://doc.spip.org/@balise_POPULARITE_SITE_dist
+/**
+ * Compile la balise `#POPULARITE_SITE` qui affiche la popularité du site
+ *
+ * La popularité du site est la somme de toutes les popularités absolues.
+ *
+ * @balise POPULARITE_SITE
+ * @link http://www.spip.net/1846 La popularité
+ * @see balise_POPULARITE_ABSOLUE_dist()
+ * @see balise_POPULARITE_dist()
+ * @see balise_POPULARITE_MAX_dist()
+ * 
+ * @param Champ $p
+ *     Pile au niveau de la balise
+ * @return Champ
+ *     Pile complétée par le code à générer
+**/
 function balise_POPULARITE_SITE_dist($p) {
 	$p->code = 'ceil($GLOBALS["meta"][\'popularite_total\'])';
 	$p->interdire_scripts = false;
 	return $p;
 }
 
-// http://doc.spip.org/@balise_POPULARITE_MAX_dist
+/**
+ * Compile la balise `#POPULARITE_MAX` qui affiche la popularité maximum
+ * parmis les popularités des articles
+ *
+ * Cela correspond à la popularité quotidienne de l'article
+ * 
+ * @balise POPULARITE_MAX
+ * @link http://www.spip.net/1846 La popularité
+ * @see balise_POPULARITE_ABSOLUE_dist()
+ * @see balise_POPULARITE_dist()
+ * @see balise_POPULARITE_SITE_dist()
+ * 
+ * @param Champ $p
+ *     Pile au niveau de la balise
+ * @return Champ
+ *     Pile complétée par le code à générer
+**/
 function balise_POPULARITE_MAX_dist($p) {
 	$p->code = 'ceil($GLOBALS["meta"][\'popularite_max\'])';
 	$p->interdire_scripts = false;
@@ -874,9 +935,23 @@ function balise_RANG_dist($p) {
 }
 
 
-// #POPULARITE
-// http://www.spip.net/fr_article1846.html
-// http://doc.spip.org/@balise_POPULARITE_dist
+/**
+ * Compile la balise `#POPULARITE` qui affiche la popularité relative.
+ * 
+ * C'est à dire le pourcentage de la fréquentation de l'article
+ * (la popularité absolue) par rapport à la popularité maximum.
+ *
+ * @balise POPULARITE
+ * @link http://www.spip.net/1846 La popularité
+ * @see balise_POPULARITE_ABSOLUE_dist()
+ * @see balise_POPULARITE_MAX_dist()
+ * @see balise_POPULARITE_SITE_dist()
+ * 
+ * @param Champ $p
+ *     Pile au niveau de la balise
+ * @return Champ
+ *     Pile complétée par le code à générer
+**/
 function balise_POPULARITE_dist ($p) {
 	$_popularite = champ_sql('popularite', $p);
 	$p->code = "(ceil(min(100, 100 * $_popularite

ecrire/public/criteres.php

@@ -299,6 +299,7 @@ function critere_pagination_dist($idb, &$boucles, $crit){
  *
  * @critere recherche
  * @link http://www.spip.net/3878
+ * @see inc_prepare_recherche_dist()
  * 
  * @param string $idb     Identifiant de la boucle
  * @param array $boucles  AST du squelette