spip / SPIP

ecrire/inc/documents.php

Doc Comments +4 added lines, -4 removed lines

@@ -40,7 +40,7 @@ 
  * @uses _DIR_IMG
  *
  * @param string $fichier
- * @return bool|string
+ * @return string|false
  */
 function get_spip_doc($fichier) {
 	// fichier distant
@@ -115,7 +115,7 @@ 
  * @param string $ext
  * @param string $orig
  * @param string $source
- * @return bool|mixed|string
+ * @return string|false
  */
 function copier_document($ext, $orig, $source) {
 
@@ -149,7 +149,7 @@ 
  * @uses sous_repertoire()
  * 
  * @param string $type
- * @return bool|string
+ * @return false|string
  */
 function determine_upload($type='') {
 	if(!function_exists('autoriser'))
@@ -184,7 +184,7 @@ 
  * @param bool $move
  *     - `true` : on déplace le fichier source vers le fichier de destination
  *     - `false` : valeur par défaut. On ne fait que copier le fichier source vers la destination.
- * @return bool|mixed|string
+ * @return string|false
  */
 function deplacer_fichier_upload($source, $dest, $move=false) {
 	// Securite

ecrire/inc/lang.php

Doc Comments +8 added lines, -1 removed lines

@@ -30,7 +30,7 @@ 
  * 
  * @param string $lang
  *     La langue à utiliser
- * @return string|bool
+ * @return false|string
  *     string : La langue qui a été utilisée si trouvée
  *     false : aucune langue ne correspondait à la demande
 **/
@@ -164,6 +164,9 @@ 
 // pour 'changer_lang' (langue de l'article, espace prive), c'est en Ajax
 // 
 // http://code.spip.net/@menu_langues
+/**
+ * @param string $nom_select
+ */
 function menu_langues($nom_select, $default='') {
 	include_spip('inc/actions');
 
@@ -194,6 +197,10 @@ 
 }
 
 // http://code.spip.net/@select_langues
+/**
+ * @param string $change
+ * @param string $options
+ */
 function select_langues($nom_select, $change, $options, $label="")
 {
 	static $cpt = 0;

ecrire/inc/math.php

Doc Comments +3 added lines

@@ -19,6 +19,9 @@
 //
 
 // http://code.spip.net/@image_math
+/**
+ * @param string $tex
+ */
 function produire_image_math($tex) {
 	global $traiter_math;
 	switch ($traiter_math) {

ecrire/inc/pclzip.php

Doc Comments +31 added lines

@@ -28,6 +28,11 @@ 
     define('PCLZIP_TEMPORARY_DIR', _DIR_TMP);
   }
   if (!function_exists('gzopen') && function_exists('gzopen64')) {
+
+    /**
+     * @param string $filename
+     * @param string $mode
+     */
     function gzopen($filename, $mode, $use_include_path = 0) {
       return gzopen64($filename, $mode, $use_include_path);
     }
@@ -221,6 +226,10 @@ 
   //   Note that no real action is taken, if the archive does not exist it is not
   //   created. Use create() for that.
   // --------------------------------------------------------------------------------
+
+  /**
+   * @param string $p_zipname
+   */
   function PclZip($p_zipname)
   {
 
@@ -2344,6 +2353,10 @@ 
   // Description :
   // Parameters :
   // --------------------------------------------------------------------------------
+
+  /**
+   * @param string $p_mode
+   */
   function privOpenFd($p_mode)
   {
     $v_result=1;
@@ -4160,6 +4173,10 @@ 
   // Parameters :
   // Return Values :
   // --------------------------------------------------------------------------------
+
+  /**
+   * @param string $p_string
+   */
   function privExtractFileAsString(&$p_entry, &$p_string, &$p_options)
   {
     $v_result=1;
@@ -5053,6 +5070,10 @@ 
   // Parameters :
   // Return Values :
   // --------------------------------------------------------------------------------
+
+  /**
+   * @param PclZip $p_archive_to_add
+   */
   function privMerge(&$p_archive_to_add)
   {
     $v_result=1;
@@ -5560,6 +5581,11 @@ 
   //             3 : src & dest gzip
   // Return Values :
   // --------------------------------------------------------------------------------
+
+  /**
+   * @param integer $p_src
+   * @param integer $p_dest
+   */
   function PclZipUtilCopyBlock($p_src, $p_dest, $p_size, $p_mode=0)
   {
     $v_result = 1;
@@ -5622,6 +5648,11 @@ 
   // Return Values :
   //   1 on success, 0 on failure.
   // --------------------------------------------------------------------------------
+
+  /**
+   * @param string $p_src
+   * @param string $p_dest
+   */
   function PclZipUtilRename($p_src, $p_dest)
   {
     $v_result = 1;

ecrire/inc/prepare_recherche.php

Doc Comments +1 added lines, -1 removed lines

@@ -138,7 +138,7 @@
  * @param string $primary
  * @param array $rows
  * @param string $serveur
- * @return array
+ * @return string[]
  */
 function generer_select_where_explicites($table, $primary, $rows, $serveur){
 	# calculer le {id_article IN()} et le {... as points}

ecrire/plugins/afficher_plugin.php

Doc Comments +7 added lines

@@ -101,6 +101,10 @@ 
 // checkbox pour activer ou desactiver
 // si ce n'est pas une extension
 
+/**
+ * @param integer $id_input
+ * @param string $file
+ */
 function plugin_checkbox($id_input, $file, $actif)
 {
 	$name = substr(md5($file),0,16);
@@ -162,6 +166,9 @@ 
 	. "</div>";
 }
 
+/**
+ * @param string $nom
+ */
 function plugin_desintalle($plug_file, $nom, $dir_plugins=null){
 	if (!$dir_plugins)
 		$dir_plugins = _DIR_PLUGINS;

ecrire/public/iterateur.php

Doc Comments +4 added lines

@@ -412,6 +412,10 @@
 	 * aller a la position $n en parcourant
 	 * un par un tous les elements
 	 */
+
+	/**
+	 * @param integer $n
+	 */
 	private function seek_loop($n) {
 		if ($this->pos > $n)
 			$this->rewind();

ecrire/public/jointures.php

Doc Comments +1 added lines, -1 removed lines

@@ -211,7 +211,7 @@
  *
  * @param array $depart
  * @param array $arrivee
- * @param string|array $col
+ * @param string $col
  * @return bool
  */
 function nogroupby_if($depart, $arrivee, $col){

ecrire/public/phraser_html.php

Doc Comments +19 added lines

@@ -214,6 +214,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;
 	$sep = '##';
@@ -229,6 +232,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) {
@@ -242,6 +248,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]);
@@ -359,6 +368,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) {
@@ -375,6 +387,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 = "";
@@ -649,6 +664,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;