spip / SPIP

ecrire/inc/puce_statut.php

Doc Comments +11 added lines

@@ -243,6 +243,12 @@ 
 }
 
 // http://doc.spip.org/@puce_statut_article_dist
+/**
+ * @param integer $id
+ * @param string $statut
+ * @param integer $id_rubrique
+ * @param boolean $menu_rapide
+ */
 function puce_statut_changement_rapide($id, $statut, $id_rubrique, $type='article', $ajax = false, $menu_rapide=_ACTIVER_PUCE_RAPIDE) {
 	$src = statut_image($type, $statut);
 	if (!$src)
@@ -317,6 +323,11 @@ 
 }
 
 // http://doc.spip.org/@afficher_script_statut
+/**
+ * @param string $type
+ * @param double $n
+ * @param string $img
+ */
 function afficher_script_statut($id, $type, $n, $img, $statut, $titre, $act='') {
 	$h = generer_action_auteur("instituer_objet","$type-$id-$statut");
 	$h = "selec_statut('$id', '$type', $n, jQuery('img',this).attr('src'), '$h');return false;";

ecrire/inc/queue.php

Doc Comments +2 added lines, -2 removed lines

@@ -268,7 +268,7 @@ 
  *
  * @param array $force_jobs
  *   list of id_job to execute when provided
- * @return null|false
+ * @return null|boolean
  */
 function queue_schedule($force_jobs = null){
 	$time = time();
@@ -394,7 +394,7 @@ 
  *
  * @param <type> $function
  * @param <type> $inclure
- * @return <type>
+ * @return integer
  */
 function queue_is_cron_job($function,$inclure){
 	static $taches = null;

ecrire/inc/rubriques.php

Doc Comments +1 added lines, -1 removed lines

@@ -44,7 +44,7 @@
  *     Ancien statut de la rubrique
  * @param bool $postdate
  *     true pour recalculer aussi la date du prochain article post-daté
- * @return bool
+ * @return boolean|null
  *     true si le statut change effectivement
 **/
 function calculer_rubriques_if ($id_rubrique, $modifs, $statut_ancien='', $postdate = false)

ecrire/inc/surligne.php

Doc Comments +3 added lines

@@ -20,6 +20,9 @@
 
 
 // http://doc.spip.org/@surligner_mots
+/**
+ * @param string $page
+ */
 function surligner_mots($page, $surcharge_surligne = '') {
 	$surlignejs_engines = array(
 		array(",".str_replace(array("/", "."), array("\/", "\."), $GLOBALS['meta']['adresse_site']).",i", ",recherche=([^&]+),i"), //SPIP

ecrire/inc/texte.php

Doc Comments +6 added lines

@@ -65,6 +65,9 @@ 
 
 // afficher joliment les <script>
 // http://doc.spip.org/@echappe_js
+/**
+ * @param string $t
+ */
 function echappe_js($t,$class=' class="echappe-js"') {
 	if (preg_match_all(',<script.*?($|</script.),isS', $t, $r, PREG_SET_ORDER))
 	foreach ($r as $regs)
@@ -256,6 +259,9 @@ 
 //
 // http://doc.spip.org/@paragrapher
 // /!\ appelee dans inc/filtres et public/composer
+/**
+ * @param string $letexte
+ */
 function paragrapher($letexte, $forcer=true) {
 	return $letexte;
 }

ecrire/inc/texte_mini.php

Doc Comments +6 added lines

@@ -58,6 +58,9 @@ 
 // une $source differente ; le script detecte automagiquement si ce qu'on
 // echappe est un div ou un span
 // http://doc.spip.org/@code_echappement
+/**
+ * @param string $mode
+ */
 function code_echappement($rempl, $source='', $no_transform=false, $mode=NULL) {
 	if (!strlen($rempl)) return '';
 
@@ -453,6 +456,9 @@ 
 // Sert aussi a nettoyer un texte qu'on veut mettre dans un <a> etc.
 // TODO: gerer les modeles ?
 // http://doc.spip.org/@supprime_img
+/**
+ * @param string $message
+ */
 function supprime_img($letexte, $message=NULL) {
 	if ($message===NULL) $message = '(' . _T('img_indisponible') . ')';
 	return preg_replace(',<(img|doc|emb)([0-9]+)(\|([^>]*))?'.'\s*/?'.'>,i',

ecrire/inc/traduire.php

Doc Comments +4 added lines, -1 removed lines

@@ -18,7 +18,7 @@ 
  * version dediee et optimisee pour cet usage de find_in_path
  *
  * @staticvar <type> $dirs
- * @param <type> $file
+ * @param string $file
  * @param <type> $dirname
  * @return <type>
  */
@@ -40,6 +40,9 @@ 
 // Charger un fichier langue
 //
 // http://doc.spip.org/@chercher_module_lang
+/**
+ * @param string $module
+ */
 function chercher_module_lang($module, $lang = '') {
 	if ($lang)
 		$lang = '_'.$lang;

ecrire/inc/urls.php

Doc Comments +2 added lines, -1 removed lines

@@ -187,8 +187,9 @@
  * @param int $id
  * @param string $args
  * @param string $ancre
- * @param string $statut
  * @param string $connect
+ * @param string $objet
+ * @param boolean $public
  * @return string
  *
  */

ecrire/inc/utils.php

Doc Comments +31 added lines, -6 removed lines

@@ -88,6 +88,9 @@ 
 // la fonction cherchant un fichier PHP dans le SPIP_PATH
 //
 // http://doc.spip.org/@include_spip
+/**
+ * @param string $f
+ */
 function include_spip($f, $include = true) {
 	return find_in_path($f . '.php', '', $include);
 }
@@ -180,8 +183,6 @@ 
  *
  * @param string $message
  * @param string|int $name
- * @param string $logdir  ## inutile !! a supprimer ?
- * @param string $logsuf  ## inutile !! a supprimer ?
  */
 function spip_log($message=NULL, $name=NULL) {
 	static $pre = array();
@@ -366,6 +367,10 @@ 
 // pour l'ancre on translitere, vire les non alphanum du debut,
 // et on remplace ceux a l'interieur ou au bout par -
 // http://doc.spip.org/@ancre_url
+/**
+ * @param null|string $url
+ * @param string $ancre
+ */
 function ancre_url($url, $ancre) {
 	// lever l'#ancre
 	if (preg_match(',^([^#]*)(#.*)$,', $url, $r)) {
@@ -596,6 +601,9 @@ 
 // Renvoie False si un fichier n'est pas plus vieux que $duree secondes,
 // sinon renvoie True et le date sauf si ca n'est pas souhaite
 // http://doc.spip.org/@spip_touch
+/**
+ * @param string $fichier
+ */
 function spip_touch($fichier, $duree=0, $touch=true) {
 	if ($duree) {
 		clearstatcache();
@@ -660,9 +668,9 @@ 
 /**
  * Ajout d'une tache dans la file d'attente
  *
- * @param $function
+ * @param string $function
  *   The function name to call.
- * @param $description
+ * @param string $description
  *   A human-readable description of the queued job.
  * @param $arguments
  *   Optional array of arguments to pass to the function.
@@ -718,7 +726,6 @@ 
  *  - si int, affecte la static directement avec la valeur
  *
  * @staticvar int $queue_next_job_time
- * @param int/bool $force_next
  * @return int
  */
 function queue_sleep_time_to_next_job($force=null) {
@@ -795,6 +802,9 @@ 
 // du path, dans cet ordre.
 // Exception: si un $dossier_squelette est defini, il reste en tete, pour raison historique
 // http://doc.spip.org/@_chemin
+/**
+ * @param string $dir_path
+ */
 function _chemin($dir_path=NULL){
 	static $path_base = NULL;
 	static $path_full = NULL;
@@ -1050,6 +1060,9 @@ 
  * @return array
  */
 // http://doc.spip.org/@find_all_in_path
+/**
+ * @param string $pattern
+ */
 function find_all_in_path($dir,$pattern, $recurs=false){
 	$liste_fichiers=array();
 	$maxfiles = 10000;
@@ -1197,6 +1210,9 @@ 
 }
 
 // http://doc.spip.org/@generer_url_entite_absolue
+/**
+ * @param boolean|string $connect
+ */
 function generer_url_entite_absolue($id='', $entite='', $args='', $ancre='', $connect=NULL)
 {
 	if (!$connect) $connect = true;
@@ -1440,6 +1456,9 @@ 
 }
 
 // http://doc.spip.org/@generer_url_action
+/**
+ * @param string $script
+ */
 function generer_url_action($script, $args="", $no_entities=false , $public = false) {
 	// si l'on est dans l'espace prive, on garde dans l'url
 	// l'exec a l'origine de l'action, qui permet de savoir si il est necessaire
@@ -2202,7 +2221,7 @@ 
 /**
  * Trouve un squelette dans le repertoire modeles/
  *
- * @param  $nom
+ * @param  string $nom
  * @return string
  */
 function trouve_modele($nom) {
@@ -2256,6 +2275,9 @@ 
 
 // Charger dynamiquement une extension php
 // http://doc.spip.org/@charger_php_extension
+/**
+ * @param string $module
+ */
 function charger_php_extension($module) {
 	if (extension_loaded($module)) {
 		return true;
@@ -2279,6 +2301,9 @@ 
  */
 // Fonction depreciee
 // http://doc.spip.org/@lire_meta
+/**
+ * @param string $nom
+ */
 function lire_meta($nom) {
 	return $GLOBALS['meta'][$nom];
 }