Completed
Pull Request — master (#1537)
by José
29:27
created
main/inc/lib/link.lib.php 1 patch
Doc Comments   +10 added lines, -1 removed lines patch added patch discarded remove patch
@@ -477,6 +477,7 @@  discard block
 block discarded – undo
477 477
      *
478 478
      * Get link info
479 479
      * @param int link id
480
+     * @param integer $id
480 481
      * @return array link info
481 482
      *
482 483
      **/
@@ -1058,7 +1059,9 @@  discard block
 block discarded – undo
1058 1059
     /**
1059 1060
      * Displays the edit, delete and move icons
1060 1061
      * @param int   Category ID
1061
-     * @return void
1062
+     * @param integer $currentCategory
1063
+     * @param integer $countCategories
1064
+     * @return string
1062 1065
      * @author Patrick Cool <[email protected]>, Ghent University
1063 1066
      */
1064 1067
     public static function showCategoryAdminTools($category, $currentCategory, $countCategories)
@@ -1222,6 +1225,7 @@  discard block
 block discarded – undo
1222 1225
     /**
1223 1226
      * CSV file import functions
1224 1227
      * @author René Haentjens , Ghent University
1228
+     * @param string $catname
1225 1229
      */
1226 1230
     public static function get_cat($catname)
1227 1231
     {
@@ -1261,6 +1265,11 @@  discard block
 block discarded – undo
1261 1265
     /**
1262 1266
      * CSV file import functions
1263 1267
      * @author René Haentjens , Ghent University
1268
+     * @param string $url
1269
+     * @param string $title
1270
+     * @param string $description
1271
+     * @param string $on_homepage
1272
+     * @param string $hidden
1264 1273
      */
1265 1274
     public static function put_link($url, $cat, $title, $description, $on_homepage, $hidden)
1266 1275
     {
Please login to merge, or discard this patch.
main/inc/lib/urlmanager.lib.php 1 patch
Doc Comments   +16 added lines, -13 removed lines patch added patch discarded remove patch
@@ -18,7 +18,7 @@  discard block
 block discarded – undo
18 18
     * @param	string	$url The URL of the site
19 19
     * @param	string  $description The description of the site
20 20
     * @param	int		$active is active or not
21
-    * @return boolean if success
21
+    * @return Doctrine\DBAL\Driver\Statement|null if success
22 22
     */
23 23
     public static function add($url, $description, $active)
24 24
     {
@@ -43,7 +43,7 @@  discard block
 block discarded – undo
43 43
     * @param	string 	$url
44 44
     * @param	string  $description The description of the site
45 45
     * @param	int		$active is active or not
46
-    * @return 	boolean if success
46
+    * @return 	Doctrine\DBAL\Driver\Statement|null if success
47 47
     */
48 48
     public static function update($url_id, $url, $description, $active)
49 49
     {
@@ -386,7 +386,7 @@  discard block
 block discarded – undo
386 386
     * @author Julio Montoya
387 387
     * @param int user id
388 388
     * @param int url id
389
-    * @return boolean true if success
389
+    * @return integer true if success
390 390
     * */
391 391
     public static function relation_url_user_exist($user_id, $url_id)
392 392
     {
@@ -404,7 +404,7 @@  discard block
 block discarded – undo
404 404
     * @author Julio Montoya
405 405
     * @param int $courseId
406 406
     * @param int $urlId
407
-    * @return boolean true if success
407
+    * @return integer true if success
408 408
     * */
409 409
     public static function relation_url_course_exist($courseId, $urlId)
410 410
     {
@@ -425,7 +425,7 @@  discard block
 block discarded – undo
425 425
      * @author Julio Montoya
426 426
      * @param int $userGroupId
427 427
      * @param int $urlId
428
-     * @return boolean true if success
428
+     * @return integer true if success
429 429
      * */
430 430
     public static function relationUrlUsergroupExist($userGroupId, $urlId)
431 431
     {
@@ -445,7 +445,7 @@  discard block
 block discarded – undo
445 445
     * @author Julio Montoya
446 446
     * @param int user id
447 447
     * @param int url id
448
-    * @return boolean true if success
448
+    * @return integer true if success
449 449
     * */
450 450
     public static function relation_url_session_exist($session_id, $url_id)
451 451
     {
@@ -568,6 +568,8 @@  discard block
 block discarded – undo
568 568
      * @author Julio Montoya
569 569
      * @param  array of course ids
570 570
      * @param  array of url_ids
571
+     * @param integer[] $courseCategoryList
572
+     * @param integer[] $urlList
571 573
      * @return array
572 574
      **/
573 575
     public static function addCourseCategoryListToUrl($courseCategoryList, $urlList)
@@ -598,7 +600,7 @@  discard block
 block discarded – undo
598 600
      * @author Julio Montoya
599 601
      * @param int $categoryCourseId
600 602
      * @param int $urlId
601
-     * @return boolean true if success
603
+     * @return integer true if success
602 604
      * */
603 605
     public static function relationUrlCourseCategoryExist($categoryCourseId, $urlId)
604 606
     {
@@ -615,7 +617,7 @@  discard block
 block discarded – undo
615 617
     /**
616 618
      * @param int $userGroupId
617 619
      * @param int $urlId
618
-     * @return int
620
+     * @return string
619 621
      */
620 622
     public static function addUserGroupToUrl($userGroupId, $urlId)
621 623
     {
@@ -716,7 +718,7 @@  discard block
 block discarded – undo
716 718
      * @param int $courseId
717 719
      * @param int $url_id
718 720
      *
719
-     * @return resource
721
+     * @return boolean
720 722
      */
721 723
     public static function add_course_to_url($courseId, $url_id = 1)
722 724
     {
@@ -807,7 +809,7 @@  discard block
 block discarded – undo
807 809
     * @param  int  $courseId
808 810
     * @param  int  $urlId
809 811
      *
810
-    * @return boolean true if success
812
+    * @return Doctrine\DBAL\Driver\Statement|null true if success
811 813
     * */
812 814
     public static function delete_url_rel_course($courseId, $urlId)
813 815
     {
@@ -825,7 +827,7 @@  discard block
 block discarded – undo
825 827
      * @param  int $userGroupId
826 828
      * @param  int $urlId
827 829
      *
828
-     * @return boolean true if success
830
+     * @return Doctrine\DBAL\Driver\Statement|null true if success
829 831
      * */
830 832
     public static function delete_url_rel_usergroup($userGroupId, $urlId)
831 833
     {
@@ -844,7 +846,7 @@  discard block
 block discarded – undo
844 846
      * @param  int $userGroupId
845 847
      * @param  int $urlId
846 848
      *
847
-     * @return boolean true if success
849
+     * @return Doctrine\DBAL\Driver\Statement|null true if success
848 850
      * */
849 851
     public static function deleteUrlRelCourseCategory($userGroupId, $urlId)
850 852
     {
@@ -862,8 +864,9 @@  discard block
 block discarded – undo
862 864
     * @author Julio Montoya
863 865
     * @param  char  course code
864 866
     * @param  int url id
867
+    * @param integer $url_id
865 868
      *
866
-    * @return boolean true if success
869
+    * @return Doctrine\DBAL\Driver\Statement|null true if success
867 870
     * */
868 871
     public static function delete_url_rel_session($session_id, $url_id)
869 872
     {
Please login to merge, or discard this patch.
src/Chamilo/CourseBundle/Entity/CForumThread.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -181,7 +181,7 @@
 block discarded – undo
181 181
 
182 182
     /**
183 183
      * set threadPeerQualify
184
-     * @param $threadPeerQualify
184
+     * @param integer $threadPeerQualify
185 185
      * @return $this
186 186
      */
187 187
     public function setThreadPeerQualify($threadPeerQualify)
Please login to merge, or discard this patch.
main/lp/openoffice_document.class.php 1 patch
Doc Comments   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -186,9 +186,9 @@
 block discarded – undo
186 186
 
187 187
     /**
188 188
      * Get images files from remote host (with webservices)
189
-     * @param   array $file current ppt file details
189
+     * @param   string $file current ppt file details
190 190
      * @param   string  $size The expected final size of the rendered slides
191
-     * @return  array images files
191
+     * @return  string images files
192 192
      */
193 193
     private function _get_remote_ppt2lp_files($file, $size = null)
194 194
     {
Please login to merge, or discard this patch.
main/inc/lib/userportal.lib.php 1 patch
Doc Comments   +6 added lines, -5 removed lines patch added patch discarded remove patch
@@ -682,6 +682,7 @@  discard block
 block discarded – undo
682 682
     * retrieves all the courses that the user has already subscribed to
683 683
     * @author Patrick Cool <[email protected]>, Ghent University, Belgium
684 684
     * @param int $user_id: the id of the user
685
+    * @param integer $user_id
685 686
     * @return array an array containing all the information of the courses of the given user
686 687
     */
687 688
     public function get_courses_of_user($user_id)
@@ -732,8 +733,8 @@  discard block
 block discarded – undo
732 733
 
733 734
     /**
734 735
      * @todo use the template system
735
-     * @param $title
736
-     * @param $content
736
+     * @param string|null $title
737
+     * @param string $content
737 738
      * @param string $id
738 739
      * @param array $params
739 740
      * @param string $idAccordion
@@ -1704,8 +1705,8 @@  discard block
 block discarded – undo
1704 1705
 
1705 1706
     /**
1706 1707
      * Return HTML code for personal user course category
1707
-     * @param $id
1708
-     * @param $title
1708
+     * @param integer $id
1709
+     * @param string $title
1709 1710
      * @return string
1710 1711
      */
1711 1712
     private static function getHtmlForUserCategory($id, $title)
@@ -1726,7 +1727,7 @@  discard block
 block discarded – undo
1726 1727
     /**
1727 1728
      * return HTML code for course display in session view
1728 1729
      * @param array $courseInfo
1729
-     * @param $userCategoryId
1730
+     * @param integer $userCategoryId
1730 1731
      * @param bool $displayButton
1731 1732
      * @param $loadDirs
1732 1733
      * @return string
Please login to merge, or discard this patch.
main/lp/learnpathItem.class.php 1 patch
Doc Comments   +5 added lines, -5 removed lines patch added patch discarded remove patch
@@ -1869,7 +1869,7 @@  discard block
 block discarded – undo
1869 1869
 
1870 1870
     /**
1871 1871
      * Get the extra terms (tags) that identify this item
1872
-     * @return mixed
1872
+     * @return string
1873 1873
      */
1874 1874
     public function get_terms()
1875 1875
     {
@@ -2069,7 +2069,7 @@  discard block
 block discarded – undo
2069 2069
 
2070 2070
     /**
2071 2071
      * Opens/launches the item. Initialises runtime values.
2072
-     * @return    boolean    True on success, false on failure.
2072
+     * @return    boolean|null    True on success, false on failure.
2073 2073
      */
2074 2074
     public function open($allow_new_attempt = false)
2075 2075
     {
@@ -3504,7 +3504,7 @@  discard block
 block discarded – undo
3504 3504
 
3505 3505
     /**
3506 3506
      * Checks if the current status is part of the list of status given
3507
-     * @param  array  $list  An array of status to check for.
3507
+     * @param  string[]  $list  An array of status to check for.
3508 3508
      * If the current status is one of the strings, return true
3509 3509
      *
3510 3510
      * @return boolean True if the status was one of the given strings,
@@ -3681,7 +3681,7 @@  discard block
 block discarded – undo
3681 3681
     /**
3682 3682
      * Write objectives to DB. This method is separate from write_to_db() because otherwise
3683 3683
      * objectives are lost as a side effect to AJAX and session concurrent access
3684
-     * @return    boolean        True or false on error
3684
+     * @return    boolean|null        True or false on error
3685 3685
      */
3686 3686
     public function write_objectives_to_db()
3687 3687
     {
@@ -4322,7 +4322,7 @@  discard block
 block discarded – undo
4322 4322
      * Removes the relation between the current item and an audio file. The file
4323 4323
      * is only removed from the lp_item table, but remains in the document table
4324 4324
      * and directory
4325
-     * @return bool
4325
+     * @return false|null
4326 4326
      */
4327 4327
     public function remove_audio()
4328 4328
     {
Please login to merge, or discard this patch.
main/lp/learnpath.class.php 1 patch
Doc Comments   +25 added lines, -22 removed lines patch added patch discarded remove patch
@@ -87,7 +87,7 @@  discard block
 block discarded – undo
87 87
      * @param   string $course Course code
88 88
      * @param   integer $lp_id
89 89
      * @param   integer $user_id
90
-     * @return  mixed True on success, false on error
90
+     * @return  boolean True on success, false on error
91 91
      */
92 92
     public function __construct($course, $lp_id, $user_id)
93 93
     {
@@ -491,7 +491,7 @@  discard block
 block discarded – undo
491 491
      * @param int $max_time_allowed
492 492
      * @param int $userId
493 493
      *
494
-     * @return int
494
+     * @return false|string
495 495
      */
496 496
     public function add_item(
497 497
         $parent,
@@ -1043,7 +1043,7 @@  discard block
 block discarded – undo
1043 1043
      * @param	array $courseInfo
1044 1044
      * @param	integer	Learnpath ID
1045 1045
      * @param	string	Whether to delete data or keep it (default: 'keep', others: 'remove')
1046
-     * @return	boolean	True on success, false on failure (might change that to return number of elements deleted)
1046
+     * @return	false|null	True on success, false on failure (might change that to return number of elements deleted)
1047 1047
      */
1048 1048
     public function delete($courseInfo = null, $id = null, $delete = 'keep')
1049 1049
     {
@@ -1182,7 +1182,7 @@  discard block
 block discarded – undo
1182 1182
      * @param	integer	$id Elem ID (0 if first)
1183 1183
      * @param	integer	$remove Whether to remove the resource/data from the
1184 1184
      * system or leave it (default: 'keep', others 'remove')
1185
-     * @return	integer	Number of elements moved
1185
+     * @return	false|null	Number of elements moved
1186 1186
      * @todo implement resource removal
1187 1187
      */
1188 1188
     public function delete_item($id, $remove = 'keep')
@@ -1264,7 +1264,7 @@  discard block
 block discarded – undo
1264 1264
      * @param   array   $audio The array resulting of the $_FILES[mp3] element
1265 1265
      * @param   int     $max_time_allowed
1266 1266
      * @param   string  $url
1267
-     * @return  boolean True on success, false on error
1267
+     * @return  false|null True on success, false on error
1268 1268
      */
1269 1269
     public function edit_item(
1270 1270
         $id,
@@ -1783,7 +1783,7 @@  discard block
 block discarded – undo
1783 1783
 
1784 1784
     /**
1785 1785
      * Gets the first element URL.
1786
-     * @return	string	URL to load into the viewer
1786
+     * @return	false|null	URL to load into the viewer
1787 1787
      */
1788 1788
     public function first()
1789 1789
     {
@@ -2297,6 +2297,7 @@  discard block
 block discarded – undo
2297 2297
      * @param int $student_id
2298 2298
      * @param string Course code (optional)
2299 2299
      * @param int $sessionId
2300
+     * @param string $courseCode
2300 2301
      * @return	bool
2301 2302
      */
2302 2303
     public static function is_lp_visible_for_student(
@@ -2594,7 +2595,7 @@  discard block
 block discarded – undo
2594 2595
 
2595 2596
     /**
2596 2597
      * Gets the learnpath session id
2597
-     * @return	string	Learnpath theme
2598
+     * @return	integer	Learnpath theme
2598 2599
      */
2599 2600
     public function get_lp_session_id()
2600 2601
     {
@@ -2627,7 +2628,7 @@  discard block
 block discarded – undo
2627 2628
     /**
2628 2629
      * @param string $size
2629 2630
      * @param string $path_type
2630
-     * @return bool|string
2631
+     * @return string|false
2631 2632
      */
2632 2633
     public function get_preview_image_path($size = null, $path_type = 'web')
2633 2634
     {
@@ -2773,6 +2774,8 @@  discard block
 block discarded – undo
2773 2774
      * Returns the XML DOM document's node
2774 2775
      * @param	resource	Reference to a list of objects to search for the given ITEM_*
2775 2776
      * @param	string		The identifier to look for
2777
+     * @param DOMNodeList $children
2778
+     * @param string $id
2776 2779
      * @return	mixed		The reference to the element found with that identifier. False if not found
2777 2780
      */
2778 2781
     public function get_scorm_xml_node(& $children, $id)
@@ -3020,7 +3023,7 @@  discard block
 block discarded – undo
3020 3023
     /**
3021 3024
      * Generate and return the table of contents for this learnpath. The (flat) table returned can be
3022 3025
      * used by get_html_toc() to be ready to display
3023
-     * @return	array	TOC as a table with 4 elements per row: title, link, status and level
3026
+     * @return	boolean	TOC as a table with 4 elements per row: title, link, status and level
3024 3027
      */
3025 3028
     public function get_toc()
3026 3029
     {
@@ -3156,7 +3159,7 @@  discard block
 block discarded – undo
3156 3159
     }
3157 3160
 
3158 3161
     /**
3159
-     * @return array
3162
+     * @return string[]
3160 3163
      */
3161 3164
     public static function getChapterTypes()
3162 3165
     {
@@ -4062,7 +4065,7 @@  discard block
 block discarded – undo
4062 4065
      * Open a resource = initialise all local variables relative to this resource. Depending on the child
4063 4066
      * class, this might be redefined to allow several behaviours depending on the document type.
4064 4067
      * @param integer Resource ID
4065
-     * @return boolean True on success, false otherwise
4068
+     * @return boolean|null True on success, false otherwise
4066 4069
      */
4067 4070
     public function open($id)
4068 4071
     {
@@ -4191,7 +4194,7 @@  discard block
 block discarded – undo
4191 4194
      * Can be used as abstract
4192 4195
      * @param	integer	$lp_id Learnpath id
4193 4196
      * @param	string	$set_visibility New visibility (v/i - visible/invisible)
4194
-     * @return bool
4197
+     * @return false|null
4195 4198
      */
4196 4199
     public static function toggle_publish($lp_id, $set_visibility = 'v')
4197 4200
     {
@@ -4276,7 +4279,7 @@  discard block
 block discarded – undo
4276 4279
      * Make sure the results are saved with anoter method. This method should probably be
4277 4280
      * redefined in children classes.
4278 4281
      * To use a similar method  statically, use the create_new_attempt() method
4279
-     * @return string URL to load in the viewer
4282
+     * @return boolean URL to load in the viewer
4280 4283
      */
4281 4284
     public function restart()
4282 4285
     {
@@ -4354,6 +4357,7 @@  discard block
 block discarded – undo
4354 4357
      * Saves the given item
4355 4358
      * @param	integer	$item_id. Optional (will take from $_REQUEST if null)
4356 4359
      * @param	boolean	$from_outside Save from url params (true) or from current attributes (false). Optional. Defaults to true
4360
+     * @param integer $item_id
4357 4361
      * @return	boolean
4358 4362
      */
4359 4363
     public function save_item($item_id = null, $from_outside = true)
@@ -4851,7 +4855,7 @@  discard block
 block discarded – undo
4851 4855
 
4852 4856
     /**
4853 4857
      * Sets use_max_score
4854
-     * @param   string  $use_max_score Optional string giving the new location of this learnpath
4858
+     * @param   integer  $use_max_score Optional string giving the new location of this learnpath
4855 4859
      * @return  boolean True on success / False on error
4856 4860
      */
4857 4861
     public function set_use_max_score($use_max_score = 1)
@@ -5254,6 +5258,7 @@  discard block
 block discarded – undo
5254 5258
      * Register the attempt mode into db thanks to flags prevent_reinit and seriousgame_mode flags
5255 5259
      *
5256 5260
      * @param string 'seriousgame', 'single' or 'multiple'
5261
+     * @param string $mode
5257 5262
      * @return boolean
5258 5263
      * @author ndiechburg <[email protected]>
5259 5264
      **/
@@ -5296,7 +5301,7 @@  discard block
 block discarded – undo
5296 5301
     /**
5297 5302
      * Switch between multiple attempt, single attempt or serious_game mode (only for scorm)
5298 5303
      *
5299
-     * @return boolean
5304
+     * @return boolean|null
5300 5305
      * @author ndiechburg <[email protected]>
5301 5306
      **/
5302 5307
     public function switch_attempt_mode()
@@ -5487,7 +5492,6 @@  discard block
 block discarded – undo
5487 5492
     /**
5488 5493
      * Function that creates a html list of learning path items so that we can add audio files to them
5489 5494
      * @author Kevin Van Den Haute
5490
-     * @param int $lp_id
5491 5495
      * @return string
5492 5496
      */
5493 5497
     public function overview()
@@ -6501,7 +6505,7 @@  discard block
 block discarded – undo
6501 6505
     /**
6502 6506
      * Function that displays a list with al the resources that
6503 6507
      * could be added to the learning path
6504
-     * @return string
6508
+     * @return boolean
6505 6509
      */
6506 6510
     public function display_resources()
6507 6511
     {
@@ -10046,7 +10050,7 @@  discard block
 block discarded – undo
10046 10050
 
10047 10051
     /**
10048 10052
      * @param int $lp_id
10049
-     * @return bool
10053
+     * @return false|null
10050 10054
      */
10051 10055
     public function scorm_export_to_pdf($lp_id)
10052 10056
     {
@@ -10581,7 +10585,7 @@  discard block
 block discarded – undo
10581 10585
 
10582 10586
     /**
10583 10587
      * @param int $itemId
10584
-     * @return learnpathItem|false
10588
+     * @return string
10585 10589
      */
10586 10590
     public function getItem($itemId)
10587 10591
     {
@@ -10631,7 +10635,6 @@  discard block
 block discarded – undo
10631 10635
     /**
10632 10636
      * Set whether this is a learning path with the possibility to subscribe
10633 10637
      * users or not
10634
-     * @param int $subscribeUsers (0 = false, 1 = true)
10635 10638
      */
10636 10639
     public function setSubscribeUsers($value)
10637 10640
     {
@@ -10756,7 +10759,7 @@  discard block
 block discarded – undo
10756 10759
 
10757 10760
     /**
10758 10761
      * Get the item of exercise type (evaluation type)
10759
-     * @return array The final evaluation. Otherwise return false
10762
+     * @return integer The final evaluation. Otherwise return false
10760 10763
      */
10761 10764
     public function getFinalEvaluationItem()
10762 10765
     {
@@ -10980,7 +10983,7 @@  discard block
 block discarded – undo
10980 10983
     /**
10981 10984
      * Create a forum for this learning path
10982 10985
      * @param type $forumCategoryId
10983
-     * @return int The forum ID if was created. Otherwise return false
10986
+     * @return false|string The forum ID if was created. Otherwise return false
10984 10987
      */
10985 10988
     public function createForum($forumCategoryId)
10986 10989
     {
Please login to merge, or discard this patch.
main/inc/lib/myspace.lib.php 1 patch
Doc Comments   +4 added lines, -3 removed lines patch added patch discarded remove patch
@@ -666,7 +666,6 @@  discard block
 block discarded – undo
666 666
      * @param   int $sessionId  The session ID
667 667
      * @param   int $courseId   The course ID
668 668
      * @param   int $exerciseId The quiz ID
669
-     * @param   int $answer Answer status (0 = incorrect, 1 = correct, 2 = both)
670 669
      * @return  string  HTML array of results formatted for gridJS
671 670
      * @author César Perales <[email protected]>, Beeznest Team
672 671
      */
@@ -1254,6 +1253,7 @@  discard block
 block discarded – undo
1254 1253
      * @param int Number of items to select
1255 1254
      * @param string Column to order on
1256 1255
      * @param string Order direction
1256
+     * @param integer $number_of_items
1257 1257
      * @return array Results
1258 1258
      */
1259 1259
     public static function get_course_data_tracking_overview($from, $number_of_items, $column, $direction)
@@ -1588,6 +1588,7 @@  discard block
 block discarded – undo
1588 1588
      * @param int Number of items to select
1589 1589
      * @param string Column to order on
1590 1590
      * @param string Order direction
1591
+     * @param integer $number_of_items
1591 1592
      * @return array Results
1592 1593
      */
1593 1594
     public static function get_session_data_tracking_overview($from, $number_of_items, $column, $direction)
@@ -1608,7 +1609,6 @@  discard block
 block discarded – undo
1608 1609
     /**
1609 1610
      * Fills in session reporting data
1610 1611
      *
1611
-     * @param integer $user_id the id of the user
1612 1612
      * @param array $url_params additonal url parameters
1613 1613
      * @param array $row the row information (the other columns)
1614 1614
      * @return string html code
@@ -2239,6 +2239,7 @@  discard block
 block discarded – undo
2239 2239
      * @author Patrick Cool <[email protected]>, Ghent University, Belgium
2240 2240
      * @version Dokeos 1.8.6
2241 2241
      * @since October 2008
2242
+     * @param integer $number_of_items
2242 2243
      */
2243 2244
     public static function get_user_data_tracking_overview($from, $number_of_items, $column, $direction)
2244 2245
     {
@@ -2341,7 +2342,6 @@  discard block
 block discarded – undo
2341 2342
     /**
2342 2343
      * Checks if there are repeted users in a given array
2343 2344
      * @param  array $usernames list of the usernames in the uploaded file
2344
-     * @param  array $user_array['username'] and $user_array['sufix'] where sufix is the number part in a login i.e -> jmontoya2
2345 2345
      * @return array with the $usernames array and the $user_array array
2346 2346
      * @author Julio Montoya Armas
2347 2347
      */
@@ -2516,6 +2516,7 @@  discard block
 block discarded – undo
2516 2516
 
2517 2517
     /**
2518 2518
      * Adds missing user-information (which isn't required, like password, etc).
2519
+     * @return integer
2519 2520
      */
2520 2521
     function complete_missing_data($user) {
2521 2522
         // 1. Generate a password if it is necessary.
Please login to merge, or discard this patch.
main/inc/lib/fileManage.lib.php 1 patch
Doc Comments   +4 added lines, -4 removed lines patch added patch discarded remove patch
@@ -39,8 +39,8 @@  discard block
 block discarded – undo
39 39
  * Deletes a file or a directory
40 40
  *
41 41
  * @author - Hugues Peeters
42
- * @param  $file (String) - the path of file or directory to delete
43
- * @return boolean - true if the delete succeed, false otherwise.
42
+ * @param  string $file (String) - the path of file or directory to delete
43
+ * @return boolean|null - true if the delete succeed, false otherwise.
44 44
  * @see    - delete() uses check_name_exist() and removeDir() functions
45 45
  */
46 46
 function my_delete($file)
@@ -127,7 +127,7 @@  discard block
 block discarded – undo
127 127
  * @author Hugues Peeters <[email protected]>
128 128
  * @param  string $file_path complete path of the file or the directory
129 129
  * @param  string $new_file_name new name for the file or the directory
130
- * @return boolean true if succeed, false otherwise
130
+ * @return string|false true if succeed, false otherwise
131 131
  * @see rename() uses the check_name_exist() and php2phps() functions
132 132
  */
133 133
 function my_rename($file_path, $new_file_name) {
@@ -174,7 +174,7 @@  discard block
 block discarded – undo
174 174
  * @param  string $target the path of the new area
175 175
  * @param  bool $forceMove Whether to force a move or to make a copy (safer but slower) and then delete the original
176 176
  * @param	bool $moveContent In some cases (including migrations), we need to move the *content* and not the folder itself
177
- * @return bool true if the move succeed, false otherwise.
177
+ * @return boolean|null true if the move succeed, false otherwise.
178 178
  * @see move() uses check_name_exist() and copyDirTo() functions
179 179
  */
180 180
 function move($source, $target, $forceMove = false, $moveContent = false)
Please login to merge, or discard this patch.