소스 검색

Minor - PHPDoc updates as suggested by @scrutinizer-auto-fixer

Yannick Warnier 7 년 전
부모
커밋
ff908f35f1

+ 13 - 16
main/dropbox/dropbox_class.inc.php

@@ -59,13 +59,12 @@ class Dropbox_Work
      * Constructor calls private functions to create a new work or retreive an existing work from DB
      * depending on the number of parameters
      *
-     * @param unknown_type $arg1
-     * @param unknown_type $arg2
-     * @param unknown_type $arg3
-     * @param unknown_type $arg4
-     * @param unknown_type $arg5
-     * @param unknown_type $arg6
-     * @return Dropbox_Work
+     * @param int $arg1
+     * @param string $arg2
+     * @param string $arg3
+     * @param string $arg4
+     * @param string $arg5
+     * @param int $arg6
      */
     public function __construct($arg1, $arg2 = null, $arg3 = null, $arg4 = null, $arg5 = null, $arg6 = null)
     {
@@ -263,14 +262,13 @@ class Dropbox_SentWork extends Dropbox_Work
 	 * Constructor calls private functions to create a new work or retreive an existing work from DB
 	 * depending on the number of parameters
 	 *
-	 * @param unknown_type $arg1
-	 * @param unknown_type $arg2
-	 * @param unknown_type $arg3
-	 * @param unknown_type $arg4
-	 * @param unknown_type $arg5
-	 * @param unknown_type $arg6
-	 * @param unknown_type $arg7
-	 * @return Dropbox_SentWork
+	 * @param int $arg1
+	 * @param string $arg2
+	 * @param string $arg3
+	 * @param string $arg4
+	 * @param string $arg5
+	 * @param int $arg6
+	 * @param array $arg7
 	 */
 	public function __construct($arg1, $arg2 = null, $arg3 = null, $arg4 = null, $arg5 = null, $arg6 = null, $arg7 = null)
     {
@@ -438,7 +436,6 @@ class Dropbox_Person
 	 * @param int $userId
 	 * @param bool $isCourseAdmin
 	 * @param bool $isCourseTutor
-	 * @return Dropbox_Person
 	 */
 	public function __construct($userId, $isCourseAdmin, $isCourseTutor)
     {

+ 1 - 3
main/exercise/export/qti2/qti2_export.php

@@ -162,7 +162,6 @@ class ImsSection
     /**
      * Constructor.
      * @param Exercise $exe The Exercise instance to export
-     * @return ImsSection
      * @author Amand Tihon <amand@alrj.org>
      */
     public function __construct($exe)
@@ -311,8 +310,7 @@ class ImsItem
     /**
     * Constructor.
     *
-    * @param $question The Question object we want to export.
-    * @return ImsItem
+    * @param Question $question The Question object we want to export.
     * @author Anamd Tihon
     */
     public function __construct($question)

+ 0 - 1
main/inc/lib/chat.lib.php

@@ -23,7 +23,6 @@ class Chat extends Model
 
     /**
      * The contructor sets the chat table name and the window_list attribute
-     * @return object Object reference
      */
     public function __construct()
     {

+ 1 - 3
main/lp/learnpathList.class.php

@@ -32,11 +32,9 @@ class LearnpathList
      * @param	string	$course_code Optional course code (otherwise we use api_get_course_id())
      * @param   int		$session_id Optional session id (otherwise we use api_get_session_id())
      * @param   string  $order_by
-     * @param   string  $check_publication_dates
+     * @param   bool  $check_publication_dates
      * @param   int     $categoryId
      * @param bool $ignoreCategoryFilter
-     *
-     * @return	void
      */
     public function __construct(
         $user_id,

+ 0 - 1
main/lp/scormMetadata.class.php

@@ -25,7 +25,6 @@ class scormMetadata
      * DOM parser.
      * @param	string	Type of creation required. Can be 'db' or 'manifest' (default)
      * @param	mixed	Depending on the type, can be the DB ID of the learnpath item or the pointer to the <metadata> element in the imsmanifest.xml file
-     * @return	boolean	True on success, false on failure
      */
     public function __construct($type = 'manifest', &$element)
     {

+ 0 - 1
plugin/pens/chamilo_pens.php

@@ -112,7 +112,6 @@ class ChamiloPens extends Plugin
     /**
      * Constructor. Takes a PENSRequest as an argument
      * @param object $request Request
-     * @return ChamiloPens
      */
     public function __construct($request)
     {