From 00713862ef72214b3ca2d1012ccd2d45b4f9c932 Mon Sep 17 00:00:00 2001
From: Christian Lefebvre <christian_lefebvre@laposte.net>
Date: Thu, 17 Jan 2008 20:16:38 +0000
Subject: [PATCH] autodoc

---
 ecrire/balise/formulaire_signature.php |  1 +
 ecrire/base/upgrade.php                |  1 +
 ecrire/exec/admin_declarer.php         |  3 ++-
 ecrire/exec/controle_petition.php      |  3 +++
 ecrire/exec/statistiques_visites.php   | 12 ++++++++++++
 ecrire/inc/distant.php                 |  1 +
 ecrire/inc/documents.php               |  1 +
 ecrire/inc/filtres.php                 |  4 ++++
 ecrire/inc/joindre.php                 |  1 +
 ecrire/inc/json.php                    |  2 ++
 ecrire/inc/securiser_action.php        |  1 +
 ecrire/public/assembler.php            |  1 +
 ecrire/public/composer.php             |  1 +
 ecrire/public/criteres.php             |  1 +
 ecrire/public/debug.php                |  1 +
 ecrire/public/jointures.php            |  3 +++
 16 files changed, 36 insertions(+), 1 deletion(-)

diff --git a/ecrire/balise/formulaire_signature.php b/ecrire/balise/formulaire_signature.php
index 92e547e708..d87ab60b59 100644
--- a/ecrire/balise/formulaire_signature.php
+++ b/ecrire/balise/formulaire_signature.php
@@ -261,6 +261,7 @@ function inc_controler_signature_dist($id_article, $nom, $mail, $message, $site,
 	return _T('form_pet_envoi_mail_confirmation');
 }
 
+// http://doc.spip.org/@signature_a_confirmer
 function signature_a_confirmer($id_article, $url_page, $nom, $mail, $site, $url, $msg, $lang, $passw)
 {
 	$row = sql_fetsel('titre,lang', 'spip_articles', "id_article=$id_article");
diff --git a/ecrire/base/upgrade.php b/ecrire/base/upgrade.php
index 2ed75aeb74..0551b89e3e 100644
--- a/ecrire/base/upgrade.php
+++ b/ecrire/base/upgrade.php
@@ -156,6 +156,7 @@ function convertir_un_champ_blob_en_text($table,$champ,$type){
 // La fonction a appeler dans le tableau global $maj 
 // quand on rajoute des types MIME. cf par exemple la 1.953
 
+// http://doc.spip.org/@upgrade_types_documents
 function upgrade_types_documents() {
 	include_spip('base/create');
 	creer_base_types_doc();
diff --git a/ecrire/exec/admin_declarer.php b/ecrire/exec/admin_declarer.php
index 492ac54f59..dc6e7549e4 100644
--- a/ecrire/exec/admin_declarer.php
+++ b/ecrire/exec/admin_declarer.php
@@ -15,7 +15,7 @@ if (!defined("_ECRIRE_INC_VERSION")) return;
 include_spip('inc/presentation');
 include_spip('inc/install');
 
-// http://doc.spip.org/@exec_admin_effacer_dist
+// http://doc.spip.org/@exec_admin_declarer_dist
 function exec_admin_declarer_dist()
 {
 	if (!autoriser('detruire')) {
@@ -50,6 +50,7 @@ function exec_admin_declarer_dist()
 	}
 }
 
+// http://doc.spip.org/@autres_bases
 function autres_bases()
 {
 	$tables =  bases_referencees(_FILE_CONNECT_TMP);
diff --git a/ecrire/exec/controle_petition.php b/ecrire/exec/controle_petition.php
index 1b3611eb35..50bb54ebd4 100644
--- a/ecrire/exec/controle_petition.php
+++ b/ecrire/exec/controle_petition.php
@@ -21,6 +21,7 @@ function exec_controle_petition_dist()
 				    intval(_request('id_signature')));
 }
 
+// http://doc.spip.org/@exec_controle_petition_args
 function exec_controle_petition_args($id_article, $type, $debut, $id_signature)
 {
 	include_spip('inc/presentation');
@@ -75,6 +76,7 @@ function exec_controle_petition_args($id_article, $type, $debut, $id_signature)
 	}
 }
 
+// http://doc.spip.org/@controle_petition_page
 function controle_petition_page($id_article, $titre,  $ong, $statut, $corps)
 {
 	$commencer_page = charger_fonction('commencer_page', 'inc');
@@ -109,6 +111,7 @@ function controle_petition_page($id_article, $titre,  $ong, $statut, $corps)
 	echo fin_gauche(), fin_page();
 }
 
+// http://doc.spip.org/@controle_petition_onglet
 function controle_petition_onglet($id_article, $debut, $type)
 {
 	$arg = ($id_article ? "id_article=$id_article&" :'');
diff --git a/ecrire/exec/statistiques_visites.php b/ecrire/exec/statistiques_visites.php
index b66def2201..a0675e9707 100644
--- a/ecrire/exec/statistiques_visites.php
+++ b/ecrire/exec/statistiques_visites.php
@@ -83,6 +83,7 @@ function exec_statistiques_visites_dist()
 	}
 }
 
+// http://doc.spip.org/@exec_statistiques_visites_args
 function exec_statistiques_visites_args($id_article, $aff_jours, $limit)
 {
 	$titre = $pourarticle = "";
@@ -275,6 +276,7 @@ function exec_statistiques_visites_args($id_article, $aff_jours, $limit)
 	echo fin_gauche(), fin_page();	
 }
 
+// http://doc.spip.org/@statistiques_signatures
 function statistiques_signatures($aff_jours, $id_article, $mode, $n)
 {
 	$stable = "spip_signatures";
@@ -303,6 +305,7 @@ function statistiques_signatures($aff_jours, $id_article, $mode, $n)
 	. statistiques_par_mois(sql_select("FROM_UNIXTIME(UNIX_TIMESTAMP(date_time),'%Y-%m') AS date_unix, COUNT(*) AS total_visites", 'spip_signatures',  "id_article=$id_article AND date_time > DATE_SUB(NOW(),INTERVAL 2700 DAY)", 'date_unix', "date_unix"), 0);
 }
 
+// http://doc.spip.org/@statistiques_collecte_date
 function statistiques_collecte_date($select, $table, $where, $groupby, $order)
 {
 	$result = sql_select($select, $table, $where, $groupby, $order);
@@ -316,6 +319,7 @@ function statistiques_collecte_date($select, $table, $where, $groupby, $order)
 
 // Appelee S'il y a au moins cinq minutes de stats :-)
 
+// http://doc.spip.org/@statistiques_tous
 function statistiques_tous($log, $date_premier, $last, $total_absolu, $val_popularite, $aff_jours, $classement=array(), $id_article=0, $liste=0)
 {
 	$r = array_keys($log);
@@ -434,6 +438,7 @@ function statistiques_tous($log, $date_premier, $last, $total_absolu, $val_popul
 
 // Le bouton pour CSV et pour passer de svg a htm
 
+// http://doc.spip.org/@statistiques_mode
 function statistiques_mode($lui)
 {
 	if (flag_svg()) {
@@ -449,6 +454,7 @@ function statistiques_mode($lui)
 		. "</div>\n";
 }
 
+// http://doc.spip.org/@stat_log1
 function stat_log1($log, $agreg, $date_debut, $date_today, $id_article, $largeur, &$total_absolu, $maxgraph, $rapport, $val_popularite, $visites_today) {
 	$res = '';
 
@@ -556,6 +562,7 @@ function stat_log1($log, $agreg, $date_debut, $date_today, $id_article, $largeur
 	return array($moyenne, $val_prec, $res);
 }
 
+// http://doc.spip.org/@statistiques_jour
 function statistiques_jour($key, $tagtitle, $largeur, $hauteur_moyenne, $hauteur) 
 {
 	if ($hauteur_moyenne > $hauteur) {
@@ -587,6 +594,7 @@ $res .= http_img_rien($largeur, $hauteur, "couleur_dimanche", $tagtitle);
 	return $res;
 }
 
+// http://doc.spip.org/@statistiques_nom_des_mois
 function statistiques_nom_des_mois($date_debut, $date_today, $largeur)
 {
 	global $spip_lang_left;
@@ -612,6 +620,7 @@ function statistiques_nom_des_mois($date_debut, $date_today, $largeur)
 	return "<div style='position: relative; height: 15px'>$res</div>";  
 }
 
+// http://doc.spip.org/@statistiques_par_mois
 function statistiques_par_mois($query, $visites_today)
  {
 	$entrees = array();
@@ -701,6 +710,7 @@ function statistiques_par_mois($query, $visites_today)
 	. "</td></tr></table>";
  }
 
+// http://doc.spip.org/@statistiques_echelle
 function statistiques_echelle($maxgraph)
 {
   return "<div class='verdana1 spip_x-small'>"
@@ -736,6 +746,7 @@ function statistiques_echelle($maxgraph)
  . "</table></div>";
 }
 	
+// http://doc.spip.org/@stat_logsvg
 function stat_logsvg($aff_jours, $agreg, $date_today, $id_article, $log, &$total_absolu, $visites_today) {
 
 	$total_absolu = $total_absolu + $visites_today;
@@ -788,6 +799,7 @@ function stat_logsvg($aff_jours, $agreg, $date_today, $id_article, $log, &$total
 	return array($moyenne, $val_prec, $res);
 }
 
+// http://doc.spip.org/@statistiques_moyenne
 function statistiques_moyenne($tab)
 {
 	if (!$tab) return 0;
diff --git a/ecrire/inc/distant.php b/ecrire/inc/distant.php
index 915212ce1f..05f989fdb5 100644
--- a/ecrire/inc/distant.php
+++ b/ecrire/inc/distant.php
@@ -435,6 +435,7 @@ function recuperer_infos_distantes($source, $max=0, $charger_si_petite_image = t
 }
 
 
+// http://doc.spip.org/@need_proxy
 function need_proxy($host)
 {
 	$http_proxy = $GLOBALS['meta']["http_proxy"];
diff --git a/ecrire/inc/documents.php b/ecrire/inc/documents.php
index 54ee7bc0fa..480ffcb730 100644
--- a/ecrire/inc/documents.php
+++ b/ecrire/inc/documents.php
@@ -44,6 +44,7 @@ function get_spip_doc($fichier) {
 
 // Filtre pour #ID_DOCUMENT ou #URL_DOCUMENT
 
+// http://doc.spip.org/@contenu_document
 function contenu_document($arg)
 {
 	if (is_numeric($arg)) {
diff --git a/ecrire/inc/filtres.php b/ecrire/inc/filtres.php
index 2c4a26e445..a0e5fd5368 100644
--- a/ecrire/inc/filtres.php
+++ b/ecrire/inc/filtres.php
@@ -28,15 +28,18 @@ function chercher_filtre($fonc, $default=NULL) {
 		return $default;
 }
 
+// http://doc.spip.org/@appliquer_filtre
 function appliquer_filtre($arg, $filtre, $default=NULL) {
 	$f = chercher_filtre(preg_replace('/\W/','_', $filtre), $default);
 	return !$f ? '' : $f($arg);
 }
 
+// http://doc.spip.org/@filtre_text_txt_dist
 function filtre_text_txt_dist($t) {
 	return '<pre>' . echapper_tags($t) . '</pre>';
 }
 
+// http://doc.spip.org/@filtre_text_csv_dist
 function filtre_text_csv_dist($t)
 {
 	list($entete, $corps) = preg_split('/\r?\n/',$t,2);
@@ -50,6 +53,7 @@ function filtre_text_csv_dist($t)
 		"|\n");
 }
 
+// http://doc.spip.org/@filtre_audio_x_pn_realaudio
 function filtre_audio_x_pn_realaudio($id)
 {
   return "
diff --git a/ecrire/inc/joindre.php b/ecrire/inc/joindre.php
index 3e91cea587..991da21668 100644
--- a/ecrire/inc/joindre.php
+++ b/ecrire/inc/joindre.php
@@ -44,6 +44,7 @@ function inc_joindre_dist($v) {
 		" method='post' enctype='multipart/form-data' class='form_upload'");
 }
 
+// http://doc.spip.org/@joindre_formulaire
 function joindre_formulaire(&$v) {
 	global $spip_lang_right;
 	$depliable = false;
diff --git a/ecrire/inc/json.php b/ecrire/inc/json.php
index 3b6907373d..2340cf0389 100644
--- a/ecrire/inc/json.php
+++ b/ecrire/inc/json.php
@@ -21,6 +21,7 @@ if (!defined("_ECRIRE_INC_VERSION")) return;
  * @return string js script | boolean false if error
  */
 
+// http://doc.spip.org/@var2js
 function var2js($var) {
 	$asso = false;
 	switch (true) {
@@ -61,6 +62,7 @@ function var2js($var) {
 	return false;
 }
 
+// http://doc.spip.org/@json_export
 function json_export($var) {
 	$var = var2js($var);
 
diff --git a/ecrire/inc/securiser_action.php b/ecrire/inc/securiser_action.php
index e91330a4a3..73a37e99a0 100644
--- a/ecrire/inc/securiser_action.php
+++ b/ecrire/inc/securiser_action.php
@@ -117,6 +117,7 @@ function verifier_action_auteur($action, $valeur) {
 
 // Le secret du site doit rester aussi secret que possible, et est eternel
 // On ne doit pas l'exporter
+// http://doc.spip.org/@secret_du_site
 function secret_du_site() {
 	if (!isset($GLOBALS['meta']['secret_du_site'])
 	OR !strlen($GLOBALS['meta']['secret_du_site'])
diff --git a/ecrire/public/assembler.php b/ecrire/public/assembler.php
index 6eecf25983..648ce45dc9 100644
--- a/ecrire/public/assembler.php
+++ b/ecrire/public/assembler.php
@@ -707,6 +707,7 @@ function inclure_modele($type, $id, $params, $lien, $connect='') {
 }
 
 // Appeler avant et apres chaque eval()
+// http://doc.spip.org/@xml_hack
 function xml_hack(&$page, $echap = false) {
 	if ($echap)
 		$page['texte'] = str_replace('<'.'?xml', "<\1?xml", $page['texte']);
diff --git a/ecrire/public/composer.php b/ecrire/public/composer.php
index b64eb242a3..5428256c8e 100644
--- a/ecrire/public/composer.php
+++ b/ecrire/public/composer.php
@@ -560,6 +560,7 @@ function calculer_jointnul($cle, $exp, $equiv='')
 	}
 }
 
+// http://doc.spip.org/@remplacer_jointnul
 function remplacer_jointnul($cle, $exp, $equiv='')
 {
 	if (!is_array($exp)) {
diff --git a/ecrire/public/criteres.php b/ecrire/public/criteres.php
index 6e00568aa1..04760179dc 100644
--- a/ecrire/public/criteres.php
+++ b/ecrire/public/criteres.php
@@ -635,6 +635,7 @@ function critere_IN_dist ($idb, &$boucles, $crit)
 		"''");
 }
 
+// http://doc.spip.org/@critere_IN_cas
 function critere_IN_cas ($idb, &$boucles, $crit2, $arg, $op, $val, $col)
 {
 	static $cpt = 0;
diff --git a/ecrire/public/debug.php b/ecrire/public/debug.php
index ea79cb31ee..038bf1bca4 100644
--- a/ecrire/public/debug.php
+++ b/ecrire/public/debug.php
@@ -532,6 +532,7 @@ function debug_dumpfile ($texte, $fonc, $type) {
 	exit;
 }
 
+// http://doc.spip.org/@debug_affiche_navig
 function debug_affiche_navig($aff, $nom_skel, $color, $self, $i)
 {
 	return "\n<tr style='background-color: " .
diff --git a/ecrire/public/jointures.php b/ecrire/public/jointures.php
index 52db566154..c5fabc52c3 100644
--- a/ecrire/public/jointures.php
+++ b/ecrire/public/jointures.php
@@ -25,6 +25,7 @@ function calculer_jointure(&$boucle, $depart, $arrivee, $col='', $cond=false)
   return fabrique_jointures($boucle, $res, $cond, $desc, $nom, $col);
 }
 
+// http://doc.spip.org/@fabrique_jointures
 function fabrique_jointures(&$boucle, $res, $cond=false, $desc=array(), $nom='', $col='')
 {
 	static $num=array();
@@ -98,6 +99,7 @@ function liste_champs_jointures($nom,$desc){
 	return $join;
 }
 
+// http://doc.spip.org/@split_key
 function split_key($v, $join = array())
 {
 	foreach (preg_split('/,\s*/', $v) as $k) $join[$k] = $k;
@@ -184,6 +186,7 @@ function trouver_champ_exterieur($cle, $joints, &$boucle, $checkarrivee = false)
 	return "";
 }
 
+// http://doc.spip.org/@trouver_jointure_champ
 function trouver_jointure_champ($champ, $boucle)
 {
 	$cle = trouver_champ_exterieur($champ, $boucle->jointures, $boucle);
-- 
GitLab