chamilo / chamilo-lms

main/inc/lib/plugin.class.php

Doc Comments +5 added lines, -5 removed lines

@@ -143,7 +143,7 @@ 
 
     /**
      * Returns the contents of the CSS defined by the plugin
-     * @return array
+     * @return string
      */
     public function get_css()
     {
@@ -161,7 +161,7 @@ 
 
     /**
      * Returns an HTML form (generated by FormValidator) of the plugin settings
-     * @return string FormValidator-generated form
+     * @return FormValidator FormValidator-generated form
      */
     public function get_settings_form()
     {
@@ -383,7 +383,7 @@ 
      * @param boolean $add_tool_link Whether to add a tool link or not
      * (some tools might just offer a configuration section and act on the backend)
      *
-     * @return boolean  False on error, null otherwise
+     * @return boolean|null  False on error, null otherwise
      */
     public function install_course_fields($courseId, $add_tool_link = true)
     {
@@ -491,7 +491,7 @@ 
      * tool on the course's homepage
      * @param int $courseId
      *
-     * @return void
+     * @return false|null
      */
     public function uninstall_course_fields($courseId)
     {
@@ -596,7 +596,7 @@ 
     * @param string   $tabName
     * @param string   $url
     *
-    * @return boolean
+    * @return false|string
     */
     public function addTab($tabName, $url)
     {

main/inc/lib/plugin.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -626,7 +626,7 @@
 
     /**
      * Get first SMS plugin name
-     * @return string|boolean
+     * @return string|false
      */
     public function getSMSPluginName()
     {

main/inc/lib/portfolio.class.php

Doc Comments +7 added lines, -3 removed lines

@@ -126,6 +126,7 @@ 
      * Returns a temporary url to download files and/or folders.
      *
      * @param string|array $ids
+     * @param string $tool
      * @return string
      */
     public static function download_url($ids, $tool)
@@ -293,7 +294,7 @@ 
     /**
      * The name of the porfolio where to send.
      *
-     * @return type
+     * @return string
      */
     function get_portfolio()
     {
@@ -391,7 +392,6 @@ 
      * Create a "send to portfolio" button
      *
      * @param string $tool          The name of the tool: document, work.
-     * @param int $c_id             The id of the course
      * @param int $id               The id of the object
      * @param array $attributes     Html attributes
      * @return \PortfolioShare
@@ -405,7 +405,7 @@ 
     /**
      * Returns the current secuirty token. Used to avoid see surfing attacks.
      *
-     * @return type
+     * @return string
      */
     static function security_token()
     {
@@ -420,6 +420,10 @@ 
     protected $attributes = array();
     protected $tool = '';
 
+    /**
+     * @param string $tool
+     * @param integer $id
+     */
     function __construct($tool, $id, $attributes = array())
     {
         $this->tool = $tool;

main/inc/lib/promotion.lib.php

Doc Comments +2 added lines, -2 removed lines

@@ -129,7 +129,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string[]
      */
     public function get_status_list()
     {
@@ -272,7 +272,7 @@ 
     /**
      * @param int $id
      *
-     * @return bool
+     * @return null|false
      */
     public function delete($id)
     {

main/inc/lib/rights.lib.php

Doc Comments +4 added lines

@@ -15,6 +15,10 @@
 
 	// warning the goal of this function is to enforce rights managment in Chamilo
 	// thus default return value is always true
+
+	/**
+	 * @param string $handler
+	 */
 	public static function hasRight($handler) {
 		if (array_key_exists($handler, self::$rights_cache))
 			return self::$rights_cache[$handler];

main/inc/lib/search/ChamiloIndexer.class.php

Doc Comments +4 added lines

@@ -71,6 +71,10 @@
 
     /**
      * Get the terms stored at database
+     * @param string $prefix
+     * @param string $course_code
+     * @param string $tool_id
+     * @param integer $ref_id
      * @return  array Array of terms
      */
     function get_terms_on_db($prefix, $course_code, $tool_id, $ref_id) {

main/inc/lib/search/ChamiloQuery.php

Doc Comments +4 added lines, -1 removed lines

@@ -23,6 +23,9 @@ 
     return chamilo_preprocess_results($results);
 }
 
+/**
+ * @param string $query_string
+ */
 function chamilo_query_simple_query($query_string, $offset=0, $length=10, $extra=NULL) {
     return xapian_query($query_string, NULL, $offset, $length, $extra);
 }
@@ -30,7 +33,7 @@ 
 /**
  * Wrapper for getting boolean queries
  *
- * @param   string    $query_string   The term string
+ * @param string $term
  */
 function chamilo_get_boolean_query($term) {
   return xapian_get_boolean_query($term);

main/inc/lib/search/search_widget.php

Doc Comments +2 added lines

@@ -273,6 +273,8 @@
 
 /**
  * Show search form
+ * @param string $action
+ * @param boolean $show_thesaurus
  */
 function display_search_form($action, $show_thesaurus, $sf_terms, $op) {
     $type = (!empty($_REQUEST['type'])? htmlentities($_REQUEST['type']): 'normal');

main/inc/lib/search/xapian/XapianIndexer.class.php

Doc Comments +4 added lines, -3 removed lines

@@ -98,7 +98,7 @@ 
 
     /**
      * Simple getter for the db attribute
-     * @return  object  The db attribute
+     * @return  null|XapianWritableDatabase  The db attribute
      */
     function getDb()
     {
@@ -108,6 +108,7 @@ 
     /**
      * Add this chunk to the chunk array attribute
      * @param  string  Chunk of text
+     * @param IndexableChunk $chunk
      * @return  void
      */
     function addChunk($chunk)
@@ -179,7 +180,7 @@ 
      * Get document data on a xapian document
      *
      * @param XapianDocument $doc xapian document to push into the db
-     * @return mixed xapian document data or FALSE if error
+     * @return string xapian document data or FALSE if error
      */
     function get_document_data($doc)
     {
@@ -286,7 +287,7 @@ 
      * Replace a document in the actual db
      *
      * @param XapianDocument $doc xapian document to push into the db
-     * @param Xapian::docid $did xapian document id of the document to replace
+     * @param integer $did xapian document id of the document to replace
      */
     function replace_document($doc, $did)
     {