chamilo / chamilo-lms

main/inc/lib/userportal.lib.php

Doc Comments +8 added lines, -7 removed lines

@@ -657,6 +657,7 @@ 
     * retrieves all the courses that the user has already subscribed to
     * @author Patrick Cool <patrick.cool@UGent.be>, Ghent University, Belgium
     * @param int $user_id: the id of the user
+    * @param integer $user_id
     * @return array an array containing all the information of the courses of the given user
     */
     public function get_courses_of_user($user_id)
@@ -707,13 +708,13 @@ 
 
     /**
      * @todo use the template system
-     * @param $title
-     * @param $content
+     * @param string|null $title
+     * @param string $content
      * @param string $id
      * @param array $params
      * @param string $idAccordion
      * @param string $idCollapse
-     * @return null|string
+     * @return string
      */
     public function show_right_block(
         $title,
@@ -937,7 +938,7 @@ 
     }
 
     /**
-     * @return null|string
+     * @return string
      */
     public function return_course_block()
     {
@@ -1590,8 +1591,8 @@ 
 
     /**
      * Return HTML code for personal user course category
-     * @param $id
-     * @param $title
+     * @param integer $id
+     * @param string $title
      * @return string
      */
     private static function getHtmlForUserCategory($id, $title)
@@ -1612,7 +1613,7 @@ 
     /**
      * return HTML code for course display in session view
      * @param array $courseInfo
-     * @param $userCategoryId
+     * @param integer $userCategoryId
      * @param bool $displayButton
      * @param $loadDirs
      * @return string

plugin/bbb/lib/bbb_plugin.class.php

Doc Comments +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
     }
 
     /**
-     * @return BBBPlugin|null
+     * @return BBBPlugin
      */
     public static function create()
     {

main/inc/lib/magpierss/extlib/Snoopy.class.inc

Doc Comments +12 added lines

@@ -366,6 +366,9 @@ 
 	Output:		$expandedLinks	the expanded links
 \*======================================================================*/
 
+	/**
+	 * @param string $links
+	 */
 	private function _expandlinks($links,$URI)
 	{
 		
@@ -400,6 +403,9 @@ 
 	Output:		
 \*======================================================================*/
 	
+	/**
+	 * @param string $http_method
+	 */
 	private function _httprequest($url,$fp,$URI,$http_method,$content_type="",$body="")
 	{
 		if($this->passcookies && $this->_redirectaddr)
@@ -583,6 +589,9 @@ 
 	Output:		
 \*======================================================================*/
 	
+	/**
+	 * @param string $http_method
+	 */
 	private function _httpsrequest($url,$URI,$http_method,$content_type="",$body="")
 	{
 		if($this->passcookies && $this->_redirectaddr)
@@ -766,6 +775,9 @@ 
 	Input:		$fp	file pointer
 \*======================================================================*/
 	
+	/**
+	 * @param boolean $fp
+	 */
 	private function _connect(&$fp)
 	{
 		if(!empty($this->proxy_host) && !empty($this->proxy_port))

main/inc/lib/magpierss/rss_cache.inc

Doc Comments +12 added lines

@@ -50,6 +50,9 @@ 
     Input:      url from wich the rss file was fetched
     Output:     true on sucess  
 \*=======================================================================*/
+    /**
+     * @param string $url
+     */
     public function set ($url, $rss) {
         $this->ERROR = "";
         $cache_file = $this->file_name( $url );
@@ -76,6 +79,9 @@ 
     Input:      url from wich the rss file was fetched
     Output:     cached object on HIT, false on MISS 
 \*=======================================================================*/ 
+    /**
+     * @param string $url
+     */
     public function get ($url) {
         $this->ERROR = "";
         $cache_file = $this->file_name( $url );
@@ -112,6 +118,9 @@ 
     Input:      url from wich the rss file was fetched
     Output:     cached object on HIT, false on MISS 
 \*=======================================================================*/     
+    /**
+     * @param string $url
+     */
     public function check_cache ( $url ) {
         $this->ERROR = "";
         $filename = $this->file_name( $url );
@@ -158,6 +167,9 @@ 
 /*=======================================================================*\
     Function:   unserialize
 \*=======================================================================*/     
+    /**
+     * @param string $data
+     */
     public function unserialize ( $data ) {
         return unserialize( $data );
     }

main/inc/lib/magpierss/rss_fetch.inc

Doc Comments +9 added lines

@@ -228,6 +228,9 @@ 
     Purpose:    set MAGPIE_ERROR, and trigger error
 \*=======================================================================*/
 
+/**
+ * @param integer $lvl
+ */
 function error ($errormsg, $lvl=E_USER_WARNING) {
         global $MAGPIE_ERROR;
         
@@ -242,6 +245,9 @@ 
         }
 }
 
+/**
+ * @param integer $lvl
+ */
 function debug ($debugmsg, $lvl=E_USER_NOTICE) {
     trigger_error("MagpieRSS [debug] $debugmsg", $lvl);
 }
@@ -288,6 +294,9 @@ 
     Input:      an HTTP response object (see Snoopy)
     Output:     parsed RSS object (see rss_parse)
 \*=======================================================================*/
+/**
+ * @param Snoopy $resp
+ */
 function _response_to_rss ($resp) {
     $rss = new MagpieRSS( $resp->results, MAGPIE_OUTPUT_ENCODING, MAGPIE_INPUT_ENCODING, MAGPIE_DETECT_ENCODING );
     

main/inc/lib/magpierss/rss_parse.inc

Doc Comments +10 added lines

@@ -449,6 +449,10 @@ 
     /**
     * return XML parser, and possibly re-encoded source
     *
+    * @param string $source
+    * @param string $out_enc
+    * @param string|null $in_enc
+    * @param boolean $detect
     */
     public function create_parser($source, $out_enc, $in_enc, $detect) {
         if ( substr(phpversion(),0,1) == 5) {
@@ -558,6 +562,9 @@ 
         }
     }
 
+    /**
+     * @param integer $lvl
+     */
     public function error ($errormsg, $lvl=E_USER_WARNING) {
         // append PHP's error message if track_errors enabled
         if ( isset($php_errormsg) ) { 
@@ -593,6 +600,9 @@ 
 	define("CASE_LOWER",0);
 
 
+	/**
+	 * @param integer $case
+	 */
 	function array_change_key_case($array,$case=CASE_LOWER) {
        if ($case=CASE_LOWER) $cmd=strtolower;
        elseif ($case=CASE_UPPER) $cmd=strtoupper;

main/inc/lib/pear/excelreader/OLERead.inc

Doc Comments +3 added lines

@@ -23,6 +23,9 @@
 //echo $data[ROOT_START_BLOCK_POS];

 //function log

 

+/**
+ * @param integer $pos
+ */
 function GetInt4d($data, $pos)

 {

 	$value = ord($data[$pos]) | (ord($data[$pos+1])	<< 8) | (ord($data[$pos+2]) << 16) | (ord($data[$pos+3]) << 24);

main/inc/lib/icalcreator/iCalcreator.class.php

Doc Comments +25 added lines, -30 removed lines

@@ -137,7 +137,7 @@ 
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 2.4.8 - 2008-10-21
      * @param string $value
-     * @return void
+     * @return false|null
      */
     function setCalscale( $value ) {
         if( empty( $value )) return FALSE;
@@ -273,7 +273,7 @@ 
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 2.4.8 - 2008-10-23
      * @param string $value
-     * @return void
+     * @return boolean
      */
     function setVersion( $value ) {
         if( empty( $value )) return FALSE;
@@ -397,7 +397,7 @@ 
      * @since 2.5.1 - 2008-11-02
      * @param string $propName, optional
      * @param int @propix, optional, if specific property is wanted in case of multiply occurences
-     * @param bool $inclParam=FALSE
+     * @param bool $inclParam
      * @return mixed
      */
     function getProperty( $propName=FALSE, $propix=FALSE, $inclParam=FALSE ) {
@@ -448,9 +448,6 @@ 
      *
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 2.2.13 - 2007-11-04
-     * @param mixed $args variable number of function arguments,
-     *                    first argument is ALWAYS component name,
-     *                    second ALWAYS component value!
      * @return bool
      */
     function setProperty () {
@@ -480,7 +477,7 @@ 
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 2.4.10 - 2008-10-23
      * @param string $config
-     * @return value
+     * @return string
      */
     function getConfig( $config ) {
         switch( strtoupper( $config )) {
@@ -701,7 +698,7 @@ 
      * @since 2.4.10 - 2008-08-05
      * @param mixed $arg1 ordno / component type / component uid
      * @param mixed $arg2 optional, ordno if arg1 = component type
-     * @return void
+     * @return boolean
      */
     function deleteComponent( $arg1, $arg2=FALSE  ) {
         $argType = $index = null;
@@ -1060,7 +1057,7 @@ 
      * @param object $component calendar component
      * @param mixed $arg1 optional, ordno/component type/ component uid
      * @param mixed $arg2 optional, ordno if arg1 = component type
-     * @return void
+     * @return boolean
      */
     function setComponent( $component, $arg1=FALSE, $arg2=FALSE  ) {
         if( '' >= $component->getConfig( 'language'))
@@ -2311,7 +2308,7 @@ 
      * @param int $min optional
      * @param int $sec optional
      * @param array $params optional
-     * @return TRUE
+     * @return boolean
      */
     function setDtstamp( $year, $month=FALSE, $day=FALSE, $hour=FALSE, $min=FALSE, $sec=FALSE, $params=FALSE ) {
         if( empty( $year ))
@@ -2794,7 +2791,7 @@ 
      * @param int $min optional
      * @param int $sec optional
      * @param array $params optional
-     * @return boll
+     * @return boolean
      */
     function setLastModified( $year=FALSE, $month=FALSE, $day=FALSE, $hour=FALSE, $min=FALSE, $sec=FALSE, $params=FALSE ) {
         if( empty( $year ))
@@ -3215,7 +3212,6 @@ 
      *
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 2.5.1 - 2008-11-07
-     * @param float $relid
      * @param array $params, optional
      * @param index $index, optional
      * @return bool
@@ -3253,7 +3249,7 @@ 
      * @since 2.4.8 - 2008-11-04
      * @param string $value
      * @param array $params optional
-     * @return void
+     * @return boolean
      */
     function setRepeat( $value, $params=FALSE ) {
         if( empty( $value )) if( $this->getConfig( 'allowEmpty' )) $value = null; else return FALSE;
@@ -3376,7 +3372,7 @@ 
      * @param array $rruleset
      * @param array $params, optional
      * @param integer $index, optional
-     * @return void
+     * @return boolean
      */
     function setRrule( $rruleset, $params=FALSE, $index=FALSE ) {
         if( empty( $rruleset )) if( $this->getConfig( 'allowEmpty' )) $rruleset = null; else return FALSE;
@@ -3802,7 +3798,7 @@ 
      * @since 2.4.8 - 2008-11-04
      * @param string $value
      * @param string $params optional
-     * @return boll
+     * @return boolean
      */
     function setTzurl( $value, $params=FALSE ) {
         if( empty( $value )) if( $this->getConfig( 'allowEmpty' )) $value = null; else return FALSE;
@@ -3931,7 +3927,7 @@ 
      * @param string $label
      * @param mixed $value
      * @param array $params optional
-     * @return bool
+     * @return null|boolean
      */
     function setXprop( $label, $value, $params=FALSE ) {
         if( empty( $label )) return;
@@ -4098,7 +4094,7 @@ 
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 0.9.22 - 2007-04-10
      * @param array $params  optional
-     * @param array $ctrKeys optional
+     * @param string[] $ctrKeys optional
      * @return string
      */
     function _createParams( $params=array(), $ctrKeys=array() ) {
@@ -4140,7 +4136,6 @@ 
      *
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 2.4.16 - 2008-10-25
-     * @param array $date, date to check
      * @param int $parno, no of date parts (i.e. year, month.. .)
      * @return array $params, property parameters
      */
@@ -4196,7 +4191,6 @@ 
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 2.2.11 - 2007-11-03
      * @param array $startdate, optional
-     * @param array $duration, optional
      * @return array duration
      */
     function _date2duration( $startdate=FALSE, $enddate=FALSE ) {
@@ -4230,7 +4224,7 @@ 
      * @since 2.4.8 - 2008-10-30
      * @param array  $datetime  datetime/(date)
      * @param string $tz        timezone
-     * @return timestamp
+     * @return integer
      */
     function _date2timestamp( $datetime, $tz=null ) {
         $output = null;
@@ -4580,6 +4574,7 @@ 
      * @param int $hitVal optional, return value if found
      * @param int $elseVal optional, return value if not found
      * @param int $preSet optional, return value if already preset
+     * @param string $expkey
      * @return int
      */
     function _existRem( &$array, $expkey, $expval=FALSE, $hitVal=null, $elseVal=null, $preSet=null ) {
@@ -4689,7 +4684,7 @@ 
      *
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 2.4.8 - 2008-10-22
-     * @param array $recurlabel
+     * @param string $recurlabel
      * @param array $recurdata
      * @return string
      */
@@ -5229,6 +5224,10 @@ 
         else
             return FALSE;
     }
+
+    /**
+     * @param integer $wkst
+     */
     function _recurIntervalIx( $freq, $date, $wkst ) {
         /* create interval index */
         switch( $freq ) {
@@ -5537,7 +5536,6 @@ 
      *
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 2.4.16 - 2008-10-19
-     * @param string $offset
      * @return integer
      */
     function _tz2offset( $tz ) {
@@ -5999,8 +5997,8 @@ 
      * @since 2.5.1 - 2008-11-02
      * @param string $propName, optional
      * @param int @propix, optional, if specific property is wanted in case of multiply occurences
-     * @param bool $inclParam=FALSE
-     * @param bool $specform=FALSE
+     * @param bool $inclParam
+     * @param bool $specform
      * @return mixed
      */
     function getProperty( $propName=FALSE, $propix=FALSE, $inclParam=FALSE, $specform=FALSE ) {
@@ -6193,9 +6191,6 @@ 
      *
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 2.5.1 - 2008-11-05
-     * @param mixed $args variable number of function arguments,
-     *                    first argument is ALWAYS component name,
-     *                    second ALWAYS component value!
      * @return void
      */
     function setProperty() {
@@ -6309,7 +6304,7 @@ 
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 2.5.2 - 2008-10-23
      * @param mixed $unparsedtext, optional, strict rfc2445 formatted, single property string or array of property strings
-     * @return bool FALSE if error occurs during parsing
+     * @return boolean|null FALSE if error occurs during parsing
      *
      */
     function parse( $unparsedtext=null ) {
@@ -6611,7 +6606,7 @@ 
      * @since 2.5.1 - 2008-10-15
      * @param mixed $arg1 ordno / component type / component uid
      * @param mixed $arg2 optional, ordno if arg1 = component type
-     * @return void
+     * @return boolean
      */
     function deleteComponent( $arg1, $arg2=FALSE  ) {
         if( !isset( $this->components )) return FALSE;
@@ -6814,7 +6809,7 @@ 
      *
      * @author Kjell-Inge Gustafsson <ical@kigkonsult.se>
      * @since 2.2.8 - 2006-09-03
-     * @param string $value
+     * @param string $string
      * @return string
      */
     function _size75( $string ) {

main/gradebook/lib/be/evallink.class.php

Doc Comments +9 added lines

@@ -117,6 +117,9 @@ 
         }
     }
 
+    /**
+     * @param string $name
+     */
     public function set_name($name)
     {
         if ($this->is_valid_link()) {
@@ -124,6 +127,9 @@ 
         }
     }
 
+    /**
+     * @param string $description
+     */
     public function set_description($description)
     {
         if ($this->is_valid_link()) {
@@ -131,6 +137,9 @@ 
         }
     }
 
+    /**
+     * @param integer $max
+     */
     public function set_max($max)
     {
         if ($this->is_valid_link()) {