woothemes / sensei

includes/class-sensei-emails.php

Doc Comments +5 added lines, -1 removed lines

@@ -40,6 +40,7 @@ 
 	 * Constructor for the email class hooks in all emails that can be sent.
 	 *
 	 * @access public
+	 * @param string $file
 	 * @return void
 	 */
 	function __construct( $file ) {
@@ -140,7 +141,7 @@ 
 	 * Wraps a message in the sensei mail template.
 	 *
 	 * @access public
-	 * @param mixed $content
+	 * @param null|string $content
 	 * @return string
 	 */
 	function wrap_message( $content ) {
@@ -198,6 +199,9 @@ 
 		remove_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ) );
 	}
 
+	/**
+	 * @param string $email_template
+	 */
 	function get_content( $email_template ) {
 
 		$message = $this->load_template( $email_template );

includes/class-sensei-list-table.php

Doc Comments +1 added lines

@@ -44,6 +44,7 @@
 	/**
 	 * Constructor
 	 * @since  1.2.0
+	 * @param string $token
 	 * @return  void
 	 */
 	public function __construct ( $token ) {

includes/class-sensei-messages.php

Doc Comments +1 added lines, -1 removed lines

@@ -299,7 +299,7 @@
      * @param  integer $sender_id   ID of sender
      * @param  integer $receiver_id ID of receiver
      * @param  string  $message     Message content
-     * @param  string  $post_id     ID of post related to message
+     * @param  integer  $post_id     ID of post related to message
      * @return mixed                Message ID on success, boolean false on failure
      */
     private function save_new_message_post( $sender_id = 0, $receiver_id = 0, $message = '', $post_id = 0 ) {

includes/class-sensei-question.php

Doc Comments +2 added lines, -2 removed lines

@@ -402,7 +402,7 @@ 
      * This function simply loads the question type template
      *
      * @since 1.9.0
-     * @param $question_type
+     * @param string $question_type
      */
     public static function load_question_template( $question_type ){
 
@@ -487,7 +487,7 @@ 
      * Get the questions media markup
      *
      * @since 1.9.0
-     * @param $question_id
+     * @param string $question_id
      * @return string
      */
     public static function get_the_question_media( $question_id ){

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/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){