spip / SPIP

ecrire/inc/plugin.php

Doc Comments +10 added lines, -1 removed lines

@@ -440,7 +440,7 @@ 
  *
  * @param $liste
  * 		Liste de description des plugins
- * @param $nom
+ * @param string $nom
  * 		Le plugin donc on cherche la presence
  * @param $version
  * 		L'éventuelle intervalle de compatibilité de la dependance. ex: [1.1.0;]
@@ -681,6 +681,9 @@ 
 	ecrire_fichier_php(_CACHE_PLUGINS_FCT, $contenu['fonctions']);
 }
 
+/**
+ * @param string $nom
+ */
 function plugin_ongletbouton($nom, $val)
 {
 	if (!$val) $val = array();
@@ -698,6 +701,9 @@ 
 // $GLOBALS['spip_pipeline']
 // $GLOBALS['spip_matrice']
 
+/**
+ * @param boolean $pipe_recherche
+ */
 function pipeline_matrice_precompile($plugin_valides, $ordre, $pipe_recherche)
 {
 	static $liste_pipe_manquants=array();
@@ -837,6 +843,9 @@ 
 	ecrire_meta('plugin_installes',serialize($meta_plug_installes),'non');
 }
 
+/**
+ * @param string $nom
+ */
 function ecrire_fichier_php($nom, $contenu, $comment='')
 {
 	ecrire_fichier($nom, 

ecrire/inc/presentation.php

Doc Comments +3 added lines

@@ -23,6 +23,9 @@
 include_spip('inc/filtres_boites');
 
 // http://doc.spip.org/@debut_cadre
+/**
+ * @param string $style
+ */
 function debut_cadre($style, $icone = "", $fonction = "", $titre = "", $id="", $class="", $padding=true) {
 	$style_mapping=array('r'=>'simple','e'=>'raccourcis','couleur'=>'basic highlight','couleur-foncee'=>'basic highlight','trait-couleur'=>'important','alerte'=>'notice','info'=>'info','sous_rub'=>'simple sous-rub');
 	$style_titre_mapping=array('couleur'=>'topper','trait-couleur'=>'section');

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;