spip / SPIP

ecrire/req/pg.exp.php

Doc Comments +29 added lines, -1 removed lines

@@ -132,6 +132,11 @@ 
 
 // Par ou ca passe une fois les traductions faites
 // https://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'];
@@ -291,6 +296,9 @@ 
 }
 
 // https://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);
@@ -417,6 +425,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
  */
@@ -592,6 +601,9 @@ 
 }
 
 // https://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));
@@ -766,6 +778,9 @@ 
 }
 
 // https://code.spip.net/@calculer_pg_where
+/**
+ * @param string $v
+ */
 function calculer_pg_where($v) {
 	if (!is_array($v)) {
 		return spip_pg_frommysql($v);
@@ -791,6 +806,9 @@ 
 
 
 // https://code.spip.net/@calculer_pg_expression
+/**
+ * @param string $expression
+ */
 function calculer_pg_expression($expression, $v, $join = 'AND') {
 	if (empty($v)) {
 		return '';
@@ -842,6 +860,9 @@ 
 }
 
 // https://code.spip.net/@spip_pg_fetch
+/**
+ * @param resource $res
+ */
 function spip_pg_fetch($res, $t = '', $serveur = '', $requeter = true) {
 
 	if ($res) {
@@ -913,6 +934,10 @@ 
 }
 
 // https://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'];
@@ -1149,6 +1174,9 @@ 
 // Pas extensible pour le moment,
 
 // https://code.spip.net/@spip_pg_sequence
+/**
+ * @return string
+ */
 function spip_pg_sequence($table, $raw = false) {
 
 	include_spip('base/serial');
@@ -1312,7 +1340,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/xml/analyser_dtd.php

Doc Comments +24 added lines

@@ -167,6 +167,9 @@ 
 }
 
 // https://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 @@ 
 }
 
 // https://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 @@ 
 }
 
 // https://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.
 
 // https://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 @@ 
 }
 
 // https://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 @@ 
 }
 
 // https://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
 
 // https://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 @@ 
 
 
 // https://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;

ecrire/xml/sax.php

Doc Comments +9 added lines

@@ -102,6 +102,9 @@ 
 		: xml_entites_html($data);
 }
 
+/**
+ * @param IndenteurXML $phraseur
+ */
 function xml_piElement($phraseur, $target, $data) {
 	$depth = $phraseur->depth;
 
@@ -118,6 +121,9 @@ 
 
 
 // https://code.spip.net/@xml_defautElement
+/**
+ * @param IndenteurXML $phraseur
+ */
 function xml_defaultElement($phraseur, $data) {
 	$depth = $phraseur->depth;
 
@@ -149,6 +155,9 @@ 
 }
 
 // https://code.spip.net/@coordonnees_erreur
+/**
+ * @param string $msg
+ */
 function coordonnees_erreur($phraseur, $msg) {
 	$entete_length = substr_count($phraseur->entete, "\n");
 	$phraseur->err[] = array(

ecrire/public/phraser_html.php

Doc Comments +22 added lines, -1 removed lines

@@ -102,6 +102,10 @@ 
 }
 
 // https://code.spip.net/@phraser_polyglotte
+/**
+ * @param string $texte
+ * @param integer $ligne
+ */
 function phraser_polyglotte($texte, $ligne, $result) {
 
 	if (preg_match_all(BALISE_POLYGLOTTE, $texte, $m, PREG_SET_ORDER)) {
@@ -266,6 +270,9 @@ 
 // on recommence tant qu'il y a des [...] en substituant a l'appel suivant
 
 // https://code.spip.net/@phraser_champs_etendus
+/**
+ * @param integer $ligne
+ */
 function phraser_champs_etendus($texte, $ligne, $result) {
 	if ($texte === "") {
 		return $result;
@@ -314,6 +321,10 @@ 
 }
 
 // https://code.spip.net/@phraser_arg
+/**
+ * @param string $texte
+ * @param string $sep
+ */
 function phraser_arg(&$texte, $sep, $result, &$pointeur_champ) {
 	preg_match(",^(\|?[^}{)|]*)(.*)$,ms", $texte, $match);
 	$suite = ltrim($match[2]);
@@ -451,6 +462,9 @@ 
 
 
 // https://code.spip.net/@phraser_champs_exterieurs
+/**
+ * @param string $texte
+ */
 function phraser_champs_exterieurs($texte, $ligne, $sep, $nested) {
 	$res = array();
 	while (($p = strpos($texte, "%$sep")) !== false) {
@@ -470,6 +484,9 @@ 
 }
 
 // https://code.spip.net/@phraser_champs_interieurs
+/**
+ * @param string $sep
+ */
 function phraser_champs_interieurs($texte, $ligne, $sep, $result) {
 	$i = 0; // en fait count($result)
 	$x = "";
@@ -766,6 +783,10 @@ 
 }
 
 // https://code.spip.net/@phraser_critere_infixe
+/**
+ * @param string $arg1
+ * @param string $arg2
+ */
 function phraser_critere_infixe($arg1, $arg2, $args, $op, $not, $cond) {
 	$args[0] = new Texte;
 	$args[0]->texte = $arg1;
@@ -895,7 +916,7 @@ 
  * @param $texte
  * @param $id_parent
  * @param $boucle
- * @param $pos_debut_texte
+ * @param integer $pos_debut_texte
  * @param $result
  * @return mixed
  */

ecrire/inc/puce_statut.php

Doc Comments +7 added lines

@@ -412,6 +412,13 @@
 }
 
 
+/**
+ * @param integer $id
+ * @param string $type
+ * @param double $n
+ * @param string|null $img
+ * @param string $titre
+ */
 function afficher_script_statut($id, $type, $n, $img, $statut, $titre, $act = '') {
 	$h = generer_action_auteur("instituer_objet", "$type-$id-$statut");
 	$t = supprimer_tags($titre);

ecrire/public/assembler.php

Doc Comments +1 added lines, -1 removed lines

@@ -467,7 +467,7 @@
  *
  * @param string|null $arg
  * @param string $operation
- * @return mixed
+ * @return null|string
  */
 function arguments_balise_dyn_depuis_modele($arg, $operation = 'set') {
 	static $balise_dyn_appellee_par_modele = null;

ecrire/inc/lang.php

Doc Comments +11 added lines, -1 removed lines

@@ -33,7 +33,7 @@ 
  *     La langue à utiliser
  * @param string|array $liste_langues
  *     La liste des langues valides
- * @return string|bool
+ * @return false|string
  *     string : La langue qui a été utilisée si trouvée
  *     false : aucune langue ne correspondait à la demande
  **/
@@ -89,6 +89,9 @@ 
 // retourne son 2e argument si c'est un index du premier
 // ou un index approchant sinon et si possible, 
 // la langue X etant consideree comme une approche de X_Y
+/**
+ * @return string
+ */
 function approcher_langue($trads, $lang = '') {
 
 	if (!$lang) {
@@ -184,6 +187,9 @@ 
 // pour 'changer_lang' (langue de l'article, espace prive), c'est en Ajax
 // 
 // https://code.spip.net/@menu_langues
+/**
+ * @param string $nom_select
+ */
 function menu_langues($nom_select, $default = '') {
 	include_spip('inc/actions');
 
@@ -218,6 +224,10 @@ 
 }
 
 // https://code.spip.net/@select_langues
+/**
+ * @param string $change
+ * @param string $options
+ */
 function select_langues($nom_select, $change, $options, $label = "") {
 	static $cpt = 0;
 	$id = "menu_langues" . $cpt++;

ecrire/inc/actions.php

Doc Comments +3 added lines, -3 removed lines

@@ -35,11 +35,11 @@ 
  *     - -1 : renvoyer action, arg et hash sous forme de array()
  *     - true ou false : renvoyer une url, avec `&` (false) ou `&` (true)
  *     - string : renvoyer un formulaire
- * @param string|int $att
+ * @param string $att
  *     - id_auteur pour lequel générer l'action en mode url ou array()
  *     - attributs du formulaire en mode formulaire
  * @param bool $public
- * @return array|string
+ * @return string
  *     URL, code HTML du formulaire ou tableau (action, arg, hash)
  */
 function generer_action_auteur($action, $arg = '', $redirect = '', $mode = false, $att = '', $public = false) {
@@ -66,7 +66,7 @@ 
  *     que l'on peut récupérer dans une fonction d'action par `_request('redirect')`
  * @param string $gra
  *     Arguments transmis au script exec de retour `arg1=yy&arg2=zz`
- * @param bool|string|int $mode
+ * @param boolean $mode
  *     - -1 : renvoyer action, arg et hash sous forme de array()
  *     - true ou false : renvoyer une url, avec `&` (false) ou `&` (true)
  *     - string : renvoyer un formulaire

ecrire/public/cacher.php

Doc Comments +1 added lines, -1 removed lines

@@ -41,7 +41,7 @@
  * Attention a modifier simultanement le sanity check de
  * la fonction retire_cache() de inc/invalideur
  *
- * @param $nom_cache
+ * @param string $nom_cache
  * @return string
  */
 function cache_chemin_fichier($nom_cache, $ecrire = false) {