woothemes / sensei

includes/admin/class-sensei-learner-management.php

Doc Comments +1 added lines

@@ -21,6 +21,7 @@
 	/**
 	 * Constructor
 	 * @since  1.6.0
+	 * @param string $file
 	 * @return  void
 	 */
 	public function __construct ( $file ) {

includes/class-sensei-modules.php

Doc Comments +4 added lines

@@ -21,6 +21,9 @@ 
     private $order_page_slug;
     public $taxonomy;
 
+    /**
+     * @param string $file
+     */
     public function __construct( $file )
     {
         $this->file = $file;
@@ -1942,6 +1945,7 @@ 
      * Hooked into 'get_terms'
      *
      * @since 1.8.0
+     * @param string[] $taxonomies
      */
     public function append_teacher_name_to_module( $terms, $taxonomies, $args )
     {

includes/class-sensei-settings-api.php

Doc Comments +1 added lines, -1 removed lines

@@ -796,7 +796,7 @@
 	 * Return an array of field types expecting an array value returned.
 	 * @access protected
 	 * @since  1.0.0
-	 * @return array
+	 * @return string[]
 	 */
 	protected function get_array_field_types () {
 		return array( 'multicheck' );

includes/class-sensei-teacher.php

Doc Comments +2 added lines, -3 removed lines

@@ -452,7 +452,7 @@ 
      * @since 1.8.0
      * @access public
      * @parameters
-     * @return array $users user id array
+     * @return boolean $users user id array
      */
     public function update_course_lessons_author ( $course_id, $new_author  ){
 
@@ -841,8 +841,7 @@ 
      * This function hooks into wp_insert_post
      *
      * @since 1.8.0
-     * @param int $course_id
-     * @return bool
+     * @return false|null
      */
     public function notify_admin_teacher_course_creation( $new_status, $old_status, $post ){
 

includes/class-sensei-updates.php

Doc Comments +4 added lines, -4 removed lines

@@ -1424,8 +1424,8 @@ 
 	 *
 	 * @global type $woothemes_sensei
 	 * @global type $wpdb
-	 * @param type $n
-	 * @param type $offset
+	 * @param integer $n
+	 * @param integer $offset
 	 * @return boolean
 	 */
 	function status_changes_repair_course_statuses( $n = 50, $offset = 0 ) {
@@ -1669,8 +1669,8 @@ 
 	 * Update the comment counts for all Courses and Lessons now that sensei comments will no longer be counted.
 	 *
 	 * @global type $wpdb
-	 * @param type $n
-	 * @param type $offset
+	 * @param integer $n
+	 * @param integer $offset
 	 * @return boolean
 	 */
 	public function update_comment_course_lesson_comment_counts( $n = 50, $offset = 0 ) {

includes/class-sensei-course.php

Doc Comments +1 added lines, -3 removed lines

@@ -850,7 +850,6 @@ 
 	 * course_count function.
 	 *
 	 * @access public
-	 * @param array $exclude (default: array())
 	 * @param string $post_status (default: 'publish')
 	 * @return int
 	 */
@@ -1152,7 +1151,6 @@ 
      *
 	 * @since  1.4.0
 	 * @param  object  $user   Queried user object
-	 * @param  boolean $manage Whether the user has permission to manage the courses
 	 * @return string          HTML displayng course data
 	 */
 	public function load_user_courses_content( $user = false ) {
@@ -1879,7 +1877,7 @@ 
      *
      * @since 1.9
      *
-     * @param WP_Post $post
+     * @param WP_Post $post_id
      */
     public function content_before_backwards_compatibility_hooks( $post_id ){
 

includes/class-sensei-admin.php

Doc Comments +3 added lines, -1 removed lines

@@ -192,7 +192,6 @@ 
 	 *
 	 * @access public
 	 * @param mixed $slug
-	 * @param mixed $option
 	 * @param string $page_title (default: '')
 	 * @param string $page_content (default: '')
 	 * @param int $post_parent (default: 0)
@@ -1037,6 +1036,9 @@ 
 		?></div><?php
 	}
 
+	/**
+	 * @return string
+	 */
 	public function get_course_order() {
 		return get_option( 'sensei_course_order', '' );
 	}

includes/class-sensei-settings.php

Doc Comments +2 added lines, -2 removed lines

@@ -60,8 +60,8 @@
     /**
      * @since 1.9.0
      *
-     * @param $setting
-     * @param $new_value
+     * @param string $setting
+     * @param integer $new_value
      */
     public function set( $setting, $new_value ){
 

includes/class-sensei-grading.php

Doc Comments +9 added lines, -8 removed lines

@@ -21,7 +21,7 @@ 
 	 * Constructor
 	 * @since  1.3.0
      *
-     * @param $file
+     * @param string $file
 	 */
 	public function __construct ( $file ) {
 		$this->name = __( 'Grading', 'woothemes-sensei' );
@@ -328,6 +328,7 @@ 
 	/**
 	 * Return array of valid statuses for either Course or Lesson
 	 * @since  1.7.0
+	 * @param string $type
 	 * @return array
 	 */
 	public function get_stati( $type ) {
@@ -527,7 +528,7 @@ 
      * the grades as the Grader selected theme and saves the total grade and
      * individual question grades.
      *
-     * @return bool
+     * @return false|null
      */
     public function admin_process_grading_submission() {
 
@@ -904,8 +905,8 @@ 
      * Grading logic specifically for the gap fill questions
      *
      * @since 1.9.0
-     * @param $question_id
-     * @param $user_answer
+     * @param integer $question_id
+     * @param string $user_answer
      *
      * @return bool | int false or the grade given to the user answer
      */
@@ -1009,7 +1010,7 @@ 
      * Add together all the graded lesson grades
      *
      * @since 1.9.0
-     * @return double $sum_of_all_grades
+     * @return integer $sum_of_all_grades
      */
     public static function get_graded_lessons_sum(){
 
@@ -1032,7 +1033,7 @@ 
      *
      * @since 1.9.0
      * @param $user_id
-     * @return double
+     * @return integer
      */
     public static function get_user_graded_lessons_sum( $user_id ){
         global $wpdb;
@@ -1055,7 +1056,7 @@ 
      * @since 1.9.0
      *
      * @param int lesson_id
-     * @return double
+     * @return integer
      */
     public static function get_lessons_users_grades_sum( $lesson_id ){
 
@@ -1080,7 +1081,7 @@ 
      * @since 1.9.0
      *
      * @param int $course_id
-     * @return double
+     * @return integer
      */
     public static function get_course_users_grades_sum( $course_id ){