spip / SPIP

ecrire/inc/texte_mini.php

Doc Comments +9 added lines

@@ -80,6 +80,9 @@ 
 // une $source differente ; le script detecte automagiquement si ce qu'on
 // echappe est un div ou un span
 // http://code.spip.net/@code_echappement
+/**
+ * @param string $mode
+ */
 function code_echappement($rempl, $source = '', $no_transform = false, $mode = null) {
 	if (!strlen($rempl)) {
 		return '';
@@ -284,6 +287,9 @@ 
 // Reinserer le javascript de confiance (venant des modeles)
 
 // http://code.spip.net/@echappe_retour_modeles
+/**
+ * @param string $letexte
+ */
 function echappe_retour_modeles($letexte, $interdire_scripts = false) {
 	$letexte = echappe_retour($letexte);
 
@@ -433,6 +439,9 @@ 
 }
 
 
+/**
+ * @param string $letexte
+ */
 function echapper_faux_tags($letexte) {
 	if (strpos($letexte, '<') === false) {
 		return $letexte;

ecrire/public/phraser_html.php

Doc Comments +23 added lines

@@ -98,6 +98,10 @@ 
 }
 
 // http://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)) {
@@ -260,6 +264,9 @@ 
 // on recommence tant qu'il y a des [...] en substituant a l'appel suivant
 
 // http://code.spip.net/@phraser_champs_etendus
+/**
+ * @param integer $ligne
+ */
 function phraser_champs_etendus($texte, $ligne, $result) {
 	if ($texte === "") {
 		return $result;
@@ -279,6 +286,9 @@ 
 // Tres chevelu
 
 // http://code.spip.net/@phraser_args
+/**
+ * @param string $fin
+ */
 function phraser_args($texte, $fin, $sep, $result, &$pointeur_champ) {
 	$texte = ltrim($texte);
 	while (($texte !== "") && strpos($fin, $texte[0]) === false) {
@@ -293,6 +303,9 @@ 
 }
 
 // http://code.spip.net/@phraser_arg
+/**
+ * @param string $texte
+ */
 function phraser_arg(&$texte, $sep, $result, &$pointeur_champ) {
 	preg_match(",^(\|?[^}{)|]*)(.*)$,ms", $texte, $match);
 	$suite = ltrim($match[2]);
@@ -430,6 +443,9 @@ 
 
 
 // http://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) {
@@ -449,6 +465,9 @@ 
 }
 
 // http://code.spip.net/@phraser_champs_interieurs
+/**
+ * @param string $sep
+ */
 function phraser_champs_interieurs($texte, $ligne, $sep, $result) {
 	$i = 0; // en fait count($result)
 	$x = "";
@@ -742,6 +761,10 @@ 
 }
 
 // http://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;

ecrire/req/mysql.php

Doc Comments +3 added lines, -3 removed lines

@@ -337,8 +337,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
@@ -970,7 +970,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_mysql_seek($r, $row_number, $serveur = '', $requeter = true) {
 	if ($r and mysqli_num_rows($r)) {

ecrire/xml/valider.php

Doc Comments +1 added lines, -1 removed lines

@@ -319,7 +319,7 @@
 	/**
 	 * Constructeur
 	 *
-	 * @param array $process ?
+	 * @param boolean $process ?
 	 **/
 	public function __construct($process = array()) {
 		if (is_array($process)) {

ecrire/req/sqlite_fonctions.php

Doc Comments +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
  * @link http://www.sqlite.org/lang_corefunc.html Liste des fonctions natives
  * @link http://sqlite.org/changes.html Liste des évolutions
  * 
- * @param PDO|resource $sqlite Représente la connexion Sqlite
+ * @param PDO $sqlite Représente la connexion Sqlite
  */
 function _sqlite_init_functions(&$sqlite) {
 

ecrire/action/editer_article.php

Doc Comments +2 added lines, -2 removed lines

@@ -160,7 +160,7 @@ 
  * @param int $id_rubrique
  *     Identifiant de la rubrique parente
  * @param array|null $set
- * @return int
+ * @return boolean|string
  *     Identifiant du nouvel article
  *
  */
@@ -533,7 +533,7 @@ 
  *
  * @param int $id_rubrique
  *     Identifiant de la rubrique
- * @return int
+ * @return boolean|string
  *     Identifiant du nouvel article
  */
 function insert_article($id_rubrique) {

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/inc/idna_convert.class.php

Doc Comments +5 added lines, -5 removed lines

@@ -88,7 +88,7 @@ 
      * the constructor
      *
      * @param array $options
-     * @return boolean
+     * @return boolean|null
      * @since 0.5.2
      */
     public function __construct($options = false)
@@ -393,7 +393,7 @@ 
     /**
      * Use this method to get the last error ocurred
      * @param    void
-     * @return   string   The last error, that occured
+     * @return   boolean   The last error, that occured
      */
     public function get_last_error()
     {
@@ -403,7 +403,7 @@ 
     /**
      * The actual decoding algorithm
      * @param string
-     * @return mixed
+     * @return false|string
      */
     protected function _decode($encoded)
     {
@@ -464,7 +464,7 @@ 
     /**
      * The actual encoding algorithm
      * @param  string
-     * @return mixed
+     * @return false|string
      */
     protected function _encode($decoded)
     {
@@ -699,7 +699,7 @@ 
      * Decomposes a Hangul syllable
      * (see http://www.unicode.org/unicode/reports/tr15/#Hangul
      * @param    integer  32bit UCS4 code point
-     * @return   array    Either Hangul Syllable decomposed or original 32bit value as one value array
+     * @return   integer[]    Either Hangul Syllable decomposed or original 32bit value as one value array
      */
     protected function _hangul_decompose($char)
     {

ecrire/action/editer_auteur.php

Doc Comments +7 added lines, -7 removed lines

@@ -85,7 +85,7 @@ 
  * @param string|null $source
  *     D'où provient l'auteur créé ? par défaut 'spip', mais peut être 'ldap' ou autre.
  * @param array|null $set
- * @return int
+ * @return boolean|string
  *     Identifiant de l'auteur créé
  */
 function auteur_inserer($source = null, $set = null) {
@@ -140,7 +140,7 @@ 
  * @param bool $force_update
  *   Permet de forcer la maj en base des champs fournis, sans passer par instancier.
  *   Utilise par auth/spip
- * @return string|null
+ * @return string|false
  *
  *     - Chaîne vide si aucune erreur,
  *     - Chaîne contenant un texte d'erreur sinon.
@@ -304,7 +304,7 @@ 
  *     Couples (colonne => valeur) des données à instituer
  * @param bool $force_webmestre
  *     Autoriser un auteur à passer webmestre (force l'autorisation)
- * @return bool|string
+ * @return false|string
  */
 function auteur_instituer($id_auteur, $c, $force_webmestre = false) {
 	if (!$id_auteur = intval($id_auteur)) {
@@ -449,7 +449,7 @@ 
  * @see auteur_inserer()
  *
  * @param string|null $source
- * @return int
+ * @return boolean|string
  */
 function insert_auteur($source = null) {
 	return auteur_inserer($source);
@@ -463,7 +463,7 @@ 
  *
  * @param int $id_auteur
  * @param array|null $set
- * @return string|null
+ * @return string|false
  */
 function auteurs_set($id_auteur, $set = null) {
 	return auteur_modifier($id_auteur, $set);
@@ -478,7 +478,7 @@ 
  * @param int $id_auteur
  * @param array $c
  * @param bool $force_webmestre
- * @return bool|string
+ * @return false|string
  */
 function instituer_auteur($id_auteur, $c, $force_webmestre = false) {
 	return auteur_instituer($id_auteur, $c, $force_webmestre);
@@ -492,7 +492,7 @@ 
  *
  * @param int $id_auteur
  * @param array $c
- * @return string|null
+ * @return string|false
  */
 function revision_auteur($id_auteur, $c = false) {
 	return auteur_modifier($id_auteur, $c);