spip / SPIP

ecrire/public/styliser_par_z.php

Doc Comments +1 added lines, -3 removed lines

@@ -201,7 +201,7 @@ 
  * @param string $type
  * @param string $ext
  * @param bool $echafauder
- * @return mixed
+ * @return string|boolean
  */
 function z_contenu_disponible($prefix_path,$z_contenu,$type,$ext,$echafauder=true){
 	if ($d = z_trouver_bloc($prefix_path,$z_contenu,$type,$ext))
@@ -295,10 +295,8 @@ 
  * tous les squelettes d'echafaudage du prive sont en fait explicites dans prive/echafaudage
  * on ne fait qu'un mini squelette d'inclusion pour reecrire les variables d'env
  *
- * @param string $type
  * @param string $table
  * @param string $table_sql
- * @param array $desc
  * @param string $ext
  * @return string
  */

ecrire/req/pg.php

Doc Comments +29 added lines, -4 removed lines

@@ -120,6 +120,11 @@ 
 
 // Par ou ca passe une fois les traductions faites
 // http://doc.spip.org/@spip_pg_trace_query
+/**
+ * @param string $query
+ *
+ * @return resource
+ */
 function spip_pg_trace_query($query, $serveur='')
 {
 	$connexion = &$GLOBALS['connexions'][$serveur ? strtolower($serveur) : 0];
@@ -255,6 +260,9 @@ 
 }
 	      
 // http://doc.spip.org/@spip_pg_alter_change
+/**
+ * @param string $arg
+ */
 function spip_pg_alter_change($table, $arg, $serveur='',$requeter=true)
 {
 	if (!preg_match('/^`?(\w+)`?\s+`?(\w+)`?\s+(.*?)\s*(DEFAULT .*?)?(NOT\s+NULL)?\s*(DEFAULT .*?)?$/i',$arg, $r)) {
@@ -373,7 +381,7 @@ 
  * 
  * @param string $nom : nom de l'index
  * @param string $table : table sql de l'index
- * @param string/array $champs : liste de champs sur lesquels s'applique l'index
+ * @param string $champs : liste de champs sur lesquels s'applique l'index
  * @param string $serveur : nom de la connexion sql utilisee
  * @param bool $requeter : true pour executer la requete ou false pour retourner le texte de la requete
  * 
@@ -424,8 +432,6 @@ 
 /**
  * Selectionne une base de donnees
  *
- * @param string $nom
- * 		Nom de la base a utiliser
  * @param string $serveur
  * 		Nom du connecteur
  * @param bool $requeter
@@ -519,6 +525,9 @@ 
 }
 
 // http://doc.spip.org/@spip_pg_orderby
+/**
+ * @param string $order
+ */
 function spip_pg_orderby($order, $select)
 {
 	$res = array();
@@ -680,6 +689,9 @@ 
 }
 
 // http://doc.spip.org/@calculer_pg_where
+/**
+ * @param string $v
+ */
 function calculer_pg_where($v)
 {
 	if (!is_array($v))
@@ -703,6 +715,9 @@ 
 
 
 // http://doc.spip.org/@calculer_pg_expression
+/**
+ * @param string $expression
+ */
 function calculer_pg_expression($expression, $v, $join = 'AND'){
 	if (empty($v))
 		return '';
@@ -749,6 +764,9 @@ 
 }
 
 // http://doc.spip.org/@spip_pg_fetch
+/**
+ * @param resource $res
+ */
 function spip_pg_fetch($res, $t='', $serveur='',$requeter=true) {
 
 	if ($res) $res = pg_fetch_array($res, NULL, PGSQL_ASSOC);
@@ -805,6 +823,10 @@ 
 }
 
 // http://doc.spip.org/@spip_pg_insert
+/**
+ * @param string $champs
+ * @param string $valeurs
+ */
 function spip_pg_insert($table, $champs, $valeurs, $desc=array(), $serveur='',$requeter=true) {
 	$connexion = &$GLOBALS['connexions'][$serveur ? strtolower($serveur) : 0];
 	$prefixe = $connexion['prefixe'];
@@ -1115,6 +1137,9 @@ 
 }
 
 // http://doc.spip.org/@spip_pg_error
+/**
+ * @param string $serveur
+ */
 function spip_pg_error($query='', $serveur, $requeter=true) {
 	$link = $GLOBALS['connexions'][$serveur ? strtolower($serveur) : 0]['link'];
 	$s = $link ? pg_last_error($link) : pg_last_error();
@@ -1158,7 +1183,7 @@ 
  * @param bool $requeter
  *     true pour éxecuter la requête
  *     false pour retourner le texte de la requête.
- * @return ressource
+ * @return resource
  *     Ressource à utiliser avec sql_fetch()
 **/
 function spip_pg_showbase($match, $serveur='',$requeter=true)

ecrire/req/sqlite_generique.php

Doc Comments +30 added lines, -7 removed lines

@@ -854,6 +854,10 @@ 
 
 
 // http://doc.spip.org/@spip_sqlite_insert
+/**
+ * @param string $champs
+ * @param string $valeurs
+ */
 function spip_sqlite_insert($table, $champs, $valeurs, $desc = '', $serveur = '', $requeter = true){
 
 	$query = "INSERT INTO $table ".($champs ? "$champs VALUES $valeurs" : "DEFAULT VALUES");
@@ -1136,8 +1140,6 @@ 
 /**
  * Selectionne un fichier de base de donnees
  *
- * @param string $nom
- * 		Nom de la base a utiliser
  * @param string $serveur
  * 		Nom du connecteur
  * @param bool $requeter
@@ -1476,7 +1478,7 @@ 
  * renvoie grosso modo "$expression join($join, $v)"
  * http://doc.spip.org/@_sqlite_calculer_expression
  *
- * @param  $expression
+ * @param  string $expression
  * @param  $v
  * @param string $join
  * @return string
@@ -1502,7 +1504,7 @@ 
  * pour conversion 0+x ? (pas la peine en sqlite)
  * http://doc.spip.org/@_sqlite_calculer_order
  *
- * @param  $orderby
+ * @param  string $orderby
  * @return string
  */
 function _sqlite_calculer_order($orderby){
@@ -1611,7 +1613,6 @@ 
  * http://doc.spip.org/@_sqlite_modifier_table
  *
  * @param string/array $table : nom_table, array(nom_table=>nom_futur)
- * @param string/array $col : nom_colonne, array(nom_colonne=>nom_futur)
  * @param array $opt : options comme les tables spip, qui sera merge a la table creee : array('field'=>array('nom'=>'syntaxe', ...), 'key'=>array('KEY nom'=>'colonne', ...))
  * @param string $serveur : nom de la connexion sql en cours
  *
@@ -2062,32 +2063,50 @@ 
 		return spip_sqlite::$requeteurs[$serveur];
 	}
 
+	/**
+	 * @param string $serveur
+	 */
 	static function traduire_requete($query, $serveur){
 		$requeteur = spip_sqlite::requeteur($serveur);
 		$traducteur = new sqlite_traducteur($query, $requeteur->prefixe,$requeteur->sqlite_version);
 		return $traducteur->traduire_requete();
 	}
 
+	/**
+	 * @param string $serveur
+	 */
 	static function demarrer_transaction($serveur){
 		spip_sqlite::executer_requete("BEGIN TRANSACTION",$serveur);
 		spip_sqlite::$transaction_en_cours[$serveur] = true;
 	}
 
+	/**
+	 * @param boolean $tracer
+	 */
 	static function executer_requete($query, $serveur, $tracer=null){
 		$requeteur = spip_sqlite::requeteur($serveur);
 		return $requeteur->executer_requete($query, $tracer);
 	}
 
+	/**
+	 * @param string $serveur
+	 */
 	static function last_insert_id($serveur){
 		$requeteur = spip_sqlite::requeteur($serveur);
 		return $requeteur->last_insert_id($serveur);
 	}
 
+	/**
+	 * @param string $serveur
+	 */
 	static function annuler_transaction($serveur){
 		spip_sqlite::executer_requete("ROLLBACK",$serveur);
 		spip_sqlite::$transaction_en_cours[$serveur] = false;
 	}
 
+	/**
+	 * @param string $serveur
+	 */
 	static function finir_transaction($serveur){
 		// si pas de transaction en cours, ne rien faire et le dire
 		if (!isset (spip_sqlite::$transaction_en_cours[$serveur])
@@ -2123,7 +2142,7 @@ 
 	 *
 	 * @param  $query
 	 * @param string $serveur
-	 * @return bool
+	 * @return false|null
 	 */
 	function sqlite_requeteur($serveur = ''){
 		_sqlite_init();
@@ -2229,6 +2248,10 @@ 
 	// Pour les corrections a effectuer sur les requetes :
 	var $textes = array(); // array(code=>'texte') trouvé
 
+	/**
+	 * @param string $prefixe
+	 * @param string $sqlite_version
+	 */
 	function sqlite_traducteur($query, $prefixe, $sqlite_version){
 		$this->query = $query;
 		$this->prefixe = $prefixe;
@@ -2242,7 +2265,7 @@ 
 	 * la fonction affecte $this->query
 	 * http://doc.spip.org/@traduire_requete
 	 *
-	 * @return void
+	 * @return string
 	 */
 	function traduire_requete(){
 		//

prive/formulaires/configurer_relayeur.php

Doc Comments +3 added lines

@@ -87,6 +87,9 @@
 	return $res;
 }
 
+/**
+ * @param string $default
+ */
 function relayeur_saisie_ou_config($http_proxy, $default){
 	// http_proxy : ne pas prendre en compte la modif si le password est '****'
 	if (preg_match(',:\*\*\*\*@,', $http_proxy))

ecrire/action/editer_liens.php

Doc Comments +1 added lines, -1 removed lines

@@ -207,7 +207,7 @@
  *
  * @api
  * @param array $objets_source
- * @param array|string $objets_lies
+ * @param string $objets_lies
  * @return int
  */
 function objet_optimiser_liens($objets_source, $objets_lies) {

ecrire/req/mysql.php

Doc Comments +4 added lines, -5 removed lines

@@ -288,7 +288,7 @@ 
 
 // http://doc.spip.org/@spip_mysql_order
 /**
- * @param $orderby
+ * @param string $orderby
  * @return string
  */
 function spip_mysql_order($orderby)
@@ -325,7 +325,7 @@ 
 
 // http://doc.spip.org/@calculer_mysql_expression
 /**
- * @param $expression
+ * @param string $expression
  * @param $v
  * @param string $join
  * @return string
@@ -420,9 +420,8 @@ 
 /**
  * Selectionne une base de donnees
  *
- * @param string $nom
- * 		Nom de la base a utiliser
  * 
+ * @param string $db
  * @return bool
  * 		True cas de success.
  * 		False en cas d'erreur.
@@ -828,7 +827,7 @@ 
 // http://doc.spip.org/@spip_mysql_insert
 /**
  * @param $table
- * @param $champs
+ * @param string $champs
  * @param $valeurs
  * @param string $desc
  * @param string $serveur

ecrire/exec/valider_xml.php

Doc Comments +11 added lines

@@ -53,6 +53,11 @@ 
 }
 
 // http://doc.spip.org/@valider_xml_ok
+/**
+ * @param string $url
+ * @param string $req_ext
+ * @param integer $limit
+ */
 function valider_xml_ok($url, $req_ext, $limit, $rec)
 {
 	$url = urldecode($url);
@@ -133,6 +138,9 @@ 
 }
 
 // http://doc.spip.org/@valider_resultats
+/**
+ * @param boolean $mode
+ */
 function valider_resultats($res, $mode)
 {
 	$i = $j = 0;
@@ -302,6 +310,9 @@ 
 }
 
 // http://doc.spip.org/@valider_dir
+/**
+ * @param string $dir
+ */
 function valider_dir($files, $ext, $dir)
 {
 	$res = array();