spip / SPIP

ecrire/public/parametrer.php

Doc Comments +1 added lines, -1 removed lines

@@ -231,7 +231,7 @@
  *
  * @uses public_tester_redirection_dist()
  * @param string $fond
- * @param array $contexte
+ * @param string $contexte
  * @param string $connect
  * @return array|bool
  */

ecrire/public/quete.php

Doc Comments +7 added lines, -7 removed lines

@@ -28,9 +28,9 @@ 
 /**
  * Retourne l'URL de redirection d'un article virtuel, seulement si il est publié
  *
- * @param $id_article
- * @param $connect
- * @return array|bool|null
+ * @param integer $id_article
+ * @param string $connect
+ * @return string
  */
 function quete_virtuel($id_article, $connect) {
 	return sql_getfetsel(
@@ -122,7 +122,7 @@ 
  * @uses quete_parent_lang()
  *
  * @param int $id_article
- * @param $serveur
+ * @param string $serveur
  * @return int
  */
 function quete_rubrique($id_article, $serveur) {
@@ -285,7 +285,7 @@ 
  *
  * @param int $id_document
  * @param string $serveur
- * @return array|bool|null
+ * @return string
  */
 function quete_fichier($id_document, $serveur = '') {
 	return sql_getfetsel('fichier', 'spip_documents', ('id_document=' . intval($id_document)), '', array(), '', '', $serveur);
@@ -307,8 +307,8 @@ 
  *
  * http://code.spip.net/@quete_meta
  *
- * @param $nom
- * @param $serveur
+ * @param string $nom
+ * @param string $serveur
  * @return array|bool|null
  */
 function quete_meta($nom, $serveur) {

ecrire/public/references.php

Doc Comments +16 added lines, -2 removed lines

@@ -293,7 +293,7 @@ 
  *           est dans une autre table et construit la jointure dessus
  *         - liste (table, champ, fonction) idem, mais en passant un
  *           nom de fonction qui s'occupera de créer la jointure.
- * @return array
+ * @return string[]
  *     Liste (nom du champ alias, nom du champ). Le nom du champ alias
  *     est une expression pour le SELECT de la boucle du style "mots.titre AS titre_mot"
  **/
@@ -471,7 +471,7 @@ 
  *     Nom de la balise
  * @param Champ $p
  *     AST au niveau de la balise
- * @return string
+ * @return Champ
  *     Code PHP pour d'exécution de la balise et de ses filtres
  **/
 function calculer_balise_DEFAUT_dist($nom, $p) {
@@ -755,6 +755,9 @@ 
 //  - deux etoiles => pas de securite non plus !
 //
 // http://code.spip.net/@applique_filtres
+/**
+ * @param Champ $p
+ */
 function applique_filtres($p) {
 
 	// Traitements standards (cf. supra)
@@ -829,6 +832,9 @@ 
 
 // Filtres et,ou,oui,non,sinon,xou,xor,and,or,not,yes
 // et comparateurs
+/**
+ * @param string $arg
+ */
 function filtre_logique($fonc, $code, $arg) {
 
 	switch (true) {
@@ -852,6 +858,9 @@ 
 }
 
 // http://code.spip.net/@compose_filtres_args
+/**
+ * @param string $sep
+ */
 function compose_filtres_args($p, $args, $sep) {
 	$arglist = "";
 	foreach ($args as $arg) {
@@ -899,6 +908,11 @@ 
 //
 
 // http://code.spip.net/@rindex_pile
+/**
+ * @param Champ $p
+ * @param string $champ
+ * @param string $motif
+ */
 function rindex_pile($p, $champ, $motif) {
 	$n = 0;
 	$b = $p->id_boucle;

ecrire/public/sandbox.php

Doc Comments +1 added lines, -1 removed lines

@@ -158,7 +158,7 @@
  * @param string $corps
  * @param array $filtres
  *     Tableau de filtres à appliquer.
- * @return mixed|string
+ * @return string
  */
 function sandbox_filtrer_squelette($skel, $corps, $filtres) {
 	$series_filtres = func_get_args();

ecrire/public/styliser_par_z.php

Doc Comments +1 added lines, -1 removed lines

@@ -236,7 +236,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)) {

ecrire/public/tracer.php

Doc Comments +3 added lines

@@ -41,6 +41,9 @@
 }
 
 // http://code.spip.net/@trace_query_chrono
+/**
+ * @param string $m2
+ */
 function trace_query_chrono($m1, $m2, $query, $result, $serveur = '') {
 	include_spip('inc/filtres_mini');
 	static $tt = 0, $nb = 0;

ecrire/req/pg.exp.php

Doc Comments +32 added lines, -1 removed lines

@@ -132,6 +132,11 @@ 
 
 // Par ou ca passe une fois les traductions faites
 // http://code.spip.net/@spip_pg_trace_query
+/**
+ * @param string $query
+ *
+ * @return resource
+ */
 function spip_pg_trace_query($query, $serveur = '') {
 	$connexion = &$GLOBALS['connexions'][$serveur ? strtolower($serveur) : 0];
 	$prefixe = $connexion['prefixe'];
@@ -290,6 +295,9 @@ 
 }
 
 // http://code.spip.net/@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)) {
 		spip_log("alter change: $arg  incompris", 'pg.' . _LOG_ERREUR);
@@ -416,6 +424,7 @@ 
  * @param string /array $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
+ * @param string $champs
  *
  * @return bool ou requete
  */
@@ -591,6 +600,9 @@ 
 }
 
 // http://code.spip.net/@spip_pg_orderby
+/**
+ * @param string $order
+ */
 function spip_pg_orderby($order, $select) {
 	$res = array();
 	$arg = (is_array($order) ? $order : preg_split('/\s*,\s*/', $order));
@@ -765,6 +777,9 @@ 
 }
 
 // http://code.spip.net/@calculer_pg_where
+/**
+ * @param string $v
+ */
 function calculer_pg_where($v) {
 	if (!is_array($v)) {
 		return spip_pg_frommysql($v);
@@ -790,6 +805,9 @@ 
 
 
 // http://code.spip.net/@calculer_pg_expression
+/**
+ * @param string $expression
+ */
 function calculer_pg_expression($expression, $v, $join = 'AND') {
 	if (empty($v)) {
 		return '';
@@ -841,6 +859,9 @@ 
 }
 
 // http://code.spip.net/@spip_pg_fetch
+/**
+ * @param resource $res
+ */
 function spip_pg_fetch($res, $t = '', $serveur = '', $requeter = true) {
 
 	if ($res) {
@@ -912,6 +933,10 @@ 
 }
 
 // http://code.spip.net/@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'];
@@ -1148,6 +1173,9 @@ 
 // Pas extensible pour le moment,
 
 // http://code.spip.net/@spip_pg_sequence
+/**
+ * @return string
+ */
 function spip_pg_sequence($table, $raw = false) {
 
 	include_spip('base/serial');
@@ -1261,6 +1289,9 @@ 
 }
 
 // http://code.spip.net/@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();
@@ -1311,7 +1342,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 +6 added lines, -6 removed lines

@@ -996,7 +996,7 @@ 
  * @param int $row_number Position. Déplacer le pointeur à cette ligne
  * @param string $serveur Nom de la connexion
  * @param bool $requeter Inutilisé
- * @return bool True si déplacement réussi, false sinon.
+ * @return boolean|null True si déplacement réussi, false sinon.
  **/
 function spip_sqlite_seek($r, $row_number, $serveur = '', $requeter = true) {
 	if ($r) {
@@ -1599,8 +1599,8 @@ 
  * @param string|array $select Champs sélectionnés
  * @param string|array $from Tables sélectionnées
  * @param string|array $where Contraintes
- * @param string|array $groupby Regroupements
- * @param string|array $orderby Tris
+ * @param string $groupby Regroupements
+ * @param string $orderby Tris
  * @param string $limit Limites de résultats
  * @param string|array $having Contraintes posts sélections
  * @param string $serveur Nom de la connexion
@@ -1758,7 +1758,7 @@ 
  * @param string $nom_table Nom de la table SQL
  * @param string $serveur Nom de la connexion
  * @param bool $requeter Exécuter la requête, sinon la retourner
- * @return array|string
+ * @return string
  *     - chaîne vide si pas de description obtenue
  *     - string Texte de la requête si demandé
  *     - array description de la table sinon
@@ -2694,7 +2694,7 @@ 
  * stocke le resultat pour ne pas faire
  * de requetes showtable intempestives
  *
- * @param  $table
+ * @param  string $table
  * @param  $couples
  * @param string $desc
  * @param string $serveur
@@ -2886,7 +2886,7 @@ 
 	 * Constructeur
 	 *
 	 * @param string $serveur
-	 * @return bool
+	 * @return false|null
 	 */
 	public function __construct($serveur = '') {
 		_sqlite_init();

ecrire/xml/analyser_dtd.php

Doc Comments +24 added lines

@@ -167,6 +167,9 @@ 
 }
 
 // http://code.spip.net/@analyser_dtd_comment
+/**
+ * @param string $dtd
+ */
 function analyser_dtd_comment($dtd, &$dtc, $grammaire) {
 	// ejecter les commentaires, surtout quand ils contiennent du code.
 	// Option /s car sur plusieurs lignes parfois
@@ -179,6 +182,9 @@ 
 }
 
 // http://code.spip.net/@analyser_dtd_pi
+/**
+ * @param string $dtd
+ */
 function analyser_dtd_pi($dtd, &$dtc, $grammaire) {
 	if (!preg_match('/^<\?.*?>\s*(.*)$/s', $dtd, $m)) {
 		return -10;
@@ -188,6 +194,9 @@ 
 }
 
 // http://code.spip.net/@analyser_dtd_lexeme
+/**
+ * @param string $dtd
+ */
 function analyser_dtd_lexeme($dtd, &$dtc, $grammaire) {
 
 	if (!preg_match(_REGEXP_ENTITY_DEF, $dtd, $m)) {
@@ -215,6 +224,9 @@ 
 // ca ne depasse pas 3 ici.
 
 // http://code.spip.net/@analyser_dtd_data
+/**
+ * @param string $dtd
+ */
 function analyser_dtd_data($dtd, &$dtc, $grammaire) {
 
 	if (!preg_match(_REGEXP_INCLUDE_USE, $dtd, $m)) {
@@ -236,6 +248,9 @@ 
 }
 
 // http://code.spip.net/@analyser_dtd_notation
+/**
+ * @param string $dtd
+ */
 function analyser_dtd_notation($dtd, &$dtc, $grammaire) {
 	if (!preg_match('/^<!NOTATION.*?>\s*(.*)$/s', $dtd, $m)) {
 		return -8;
@@ -246,6 +261,9 @@ 
 }
 
 // http://code.spip.net/@analyser_dtd_entity
+/**
+ * @param string $dtd
+ */
 function analyser_dtd_entity($dtd, &$dtc, $grammaire) {
 	if (!preg_match(_REGEXP_ENTITY_DECL, $dtd, $m)) {
 		return -2;
@@ -303,6 +321,9 @@ 
 // Fin du controle en finElement
 
 // http://code.spip.net/@analyser_dtd_element
+/**
+ * @param string $dtd
+ */
 function analyser_dtd_element($dtd, &$dtc, $grammaire) {
 	if (!preg_match('/^<!ELEMENT\s+([^>\s]+)([^>]*)>\s*(.*)$/s', $dtd, $m)) {
 		return -3;
@@ -351,6 +372,9 @@ 
 
 
 // http://code.spip.net/@analyser_dtd_attlist
+/**
+ * @param string $dtd
+ */
 function analyser_dtd_attlist($dtd, &$dtc, $grammaire) {
 	if (!preg_match('/^<!ATTLIST\s+(\S+)\s+([^>]*)>\s*(.*)/s', $dtd, $m)) {
 		return -5;