woothemes / sensei

includes/class-sensei-quiz.php

Doc Comments +4 added lines, -5 removed lines

@@ -123,7 +123,7 @@ 
      *
      * This function hooks into the quiz page and accepts the answer form save post.
      * @since 1.7.3
-     * @return bool $saved;
+     * @return boolean|null $saved;
      */
     public function user_save_quiz_answers_listener(){
 
@@ -214,7 +214,7 @@ 
 	 * @param int $lesson_id
 	 * @param int $user_id
 	 *
-	 * @return array $answers or false
+	 * @return boolean $answers or false
 	 */
 	public function get_user_answers( $lesson_id, $user_id ){
 
@@ -707,7 +707,7 @@ 
       *      @type int $question_id
       *      @type int $question_grade
       * }
-      * @param $lesson_id
+      * @param integer $lesson_id
       * @param $user_id (Optional) will use the current user if not supplied
       *
       * @return bool
@@ -754,7 +754,7 @@ 
       *
       * @since 1.7.4
       *
-      * @param $lesson_id
+      * @param integer $lesson_id
       * @param $user_id (Optional) will use the current user if not supplied
       *
       * @return array $user_quiz_grades or false if none exists for this users
@@ -1090,7 +1090,6 @@ 
       * Filter the single title and add the Quiz to it.
       *
       * @param string $title
-      * @param int $id title post id
       * @return string $quiz_title
       */
      public static function single_quiz_title( $title, $post_id ){

includes/class-sensei-settings-api.php

Doc Comments +1 added lines, -1 removed lines

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

includes/class-sensei-teacher.php

Doc Comments +3 added lines, -4 removed lines

@@ -363,7 +363,7 @@ 
      *
      * @param $course_id
      * @param $new_teacher_id
-     * @return void
+     * @return false|null
      */
     public static function update_course_modules_author( $course_id ,$new_teacher_id ){
 
@@ -454,7 +454,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  ){
 
@@ -843,8 +843,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 +8 added lines, -8 removed lines

@@ -455,7 +455,7 @@ 
 	 *
 	 * @since  1.1.0
 	 * @access public
-	 * @return void
+	 * @return boolean
 	 */
 	public function assign_role_caps() {
 		foreach ( $this->parent->post_types->role_caps as $role_cap_set  ) {
@@ -480,7 +480,7 @@ 
 	 *
 	 * @since 1.3.0
 	 * @access public
-	 * @return void
+	 * @return boolean
 	 */
 	public function set_default_quiz_grade_type() {
 		$args = array(	'post_type' 		=> 'quiz',
@@ -502,7 +502,7 @@ 
 	 *
 	 * @since 1.3.0
 	 * @access public
-	 * @return void
+	 * @return boolean
 	 */
 	public function set_default_question_type() {
 		$args = array(	'post_type' 		=> 'question',
@@ -532,7 +532,7 @@ 
 	 *
 	 * @since 1.3.0
 	 * @access public
-	 * @return void
+	 * @return boolean
 	 */
 	public function update_question_answer_data( $n = 50, $offset = 0 ) {
 
@@ -1429,8 +1429,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 ) {
@@ -1674,8 +1674,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/sensei-functions.php

Doc Comments +2 added lines, -2 removed lines

@@ -178,8 +178,8 @@
  *
  * @since 1.9.0
  *
- * @param $hook_tag
- * @param $version
+ * @param string $hook_tag
+ * @param string $version
  * @param $alternative
  * @param array $args
  */

includes/shortcodes/class-sensei-legacy-shortcodes.php

Doc Comments +2 added lines, -2 removed lines

@@ -103,8 +103,8 @@
      *
      * @since 1.9.0
      *
-     * @param $title
-     * @param $shortcode_specific_override
+     * @param string $title
+     * @param string $shortcode_specific_override
      * @return string
      */
     public static function generate_shortcode_courses( $title , $shortcode_specific_override  ){

includes/shortcodes/class-sensei-shortcode-course-categories.php

Doc Comments +1 added lines, -1 removed lines

@@ -114,7 +114,7 @@
      *
      * @since 1.9.0
      *
-     * @param array $category_ids
+     * @param array $categories
      * @return array
      */
     public function generate_term_ids( $categories = array() ){

includes/shortcodes/class-sensei-shortcode-user-courses.php

Doc Comments +1 added lines, -1 removed lines

@@ -325,7 +325,7 @@
      *
      * @param array $classes
      * @param WP_Post $course
-     * @return array $classes
+     * @return string[] $classes
      */
     public function course_status_class_tagging($classes, $course){
 

widgets/widget-woothemes-sensei-course-component.php

Doc Comments -2 removed lines

@@ -167,8 +167,6 @@
 

 	/**

 	 * Load the desired component, if a method is available for it.

-	 * @param  string $component The component to potentially be loaded.

-     *

 	 * @since  1.0.0

 	 * @return void

 	 */