woothemes / sensei

apigen/hook-docs.php

Doc Comments +3 added lines

@@ -10,6 +10,9 @@
 	private static $found_files            = array();
 	private static $custom_hooks_found     = '';
 
+	/**
+	 * @param string $pattern
+	 */
 	private static function get_files( $pattern, $flags = 0, $path = '' ) {
 
 	    if ( ! $path && ( $dir = dirname( $pattern ) ) != '.' ) {

includes/class-sensei-analysis.php

Doc Comments +8 added lines, -1 removed lines

@@ -21,6 +21,7 @@ 
 	/**
 	 * Constructor
 	 * @since  1.0.0
+	 * @param string $file
 	 * @return  void
 	 */
 	public function __construct ( $file ) {
@@ -215,6 +216,7 @@ 
 	/**
 	 * An individual users' profile view for analysis, showing their Courses
 	 * @since  1.2.0
+	 * @param integer $user_id
 	 * @return void
 	 */
 	public function analysis_user_profile_view( $user_id ) {
@@ -242,6 +244,7 @@ 
 	/**
 	 * An individual Course view for analysis, showing the Courses Lessons
 	 * @since  1.2.0
+	 * @param integer $course_id
 	 * @return void
 	 */
 	public function analysis_course_view( $course_id ) {
@@ -269,6 +272,8 @@ 
 	/**
 	 * An individual Course view for analysis, showing a specific Learners Lessons
 	 * @since  1.2.0
+	 * @param integer $course_id
+	 * @param integer $user_id
 	 * @return void
 	 */
 	public function analysis_user_course_view( $course_id, $user_id ) {
@@ -296,6 +301,7 @@ 
 	/**
 	 * An individual Course view for analysis, showing all the Learners
 	 * @since  1.2.0
+	 * @param integer $course_id
 	 * @return void
 	 */
 	public function analysis_course_users_view( $course_id ) {
@@ -323,6 +329,7 @@ 
 	/**
 	 * An individual Lesson view for analysis, showing all the Learners
 	 * @since  1.2.0
+	 * @param integer $lesson_id
 	 * @return void
 	 */
 	public function analysis_lesson_users_view( $lesson_id ) {
@@ -633,7 +640,7 @@ 
 	/**
 	 * Write array data to CSV
 	 * @since  1.2.0
-	 * @param  array  $report_array data array
+	 * @param  array  $report_data data array
 	 * @return void
 	 */
 	public function report_write_download( $report_data = array() ) {

includes/class-sensei-course.php

Doc Comments +1 added lines, -3 removed lines

@@ -372,7 +372,7 @@ 
 	 *
 	 * @access public
 	 * @param int $post_id
-	 * @return void
+	 * @return integer|null
 	 */
 	public function meta_box_save ( $post_id ) {
 		global $post, $messages;
@@ -848,7 +848,6 @@ 
 	 * course_count function.
 	 *
 	 * @access public
-	 * @param array $exclude (default: array())
 	 * @param string $post_status (default: 'publish')
 	 * @return int
 	 */
@@ -1159,7 +1158,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 ) {

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-frontend.php

Doc Comments +2 added lines, -3 removed lines

@@ -473,7 +473,6 @@ 
 	 * Remove Sensei custom menu items depending on settings and logged in status.
 	 *
 	 * @access public
-	 * @param object $item
 	 * @return object $item
 	 */
 	public function sensei_wp_nav_menu_objects( $sorted_menu_items ) {
@@ -530,7 +529,7 @@ 
      *
      * @deprecated since 1.9.0
 	 * @since  1.2.0
-	 * @return void
+	 * @return string|null
 	 */
 	function sensei_course_image( $course_id, $width = '100', $height = '100', $return = false ) {
 
@@ -551,7 +550,7 @@ 
 	/**
 	 * sensei_lesson_image output for lesson image
 	 * @since  1.2.0
-	 * @return void
+	 * @return string|null
      * @deprecated since 1.9.0
 	 */
 	function sensei_lesson_image( $lesson_id, $width = '100', $height = '100', $return = false, $widget = false ) {

includes/class-sensei-grading.php

Doc Comments +5 added lines, -4 removed lines

@@ -22,7 +22,7 @@ 
 	 * Constructor
 	 * @since  1.3.0
      *
-     * @param $file
+     * @param string $file
 	 */
 	public function __construct ( $file ) {
 		$this->name = __( 'Grading', 'woothemes-sensei' );
@@ -330,6 +330,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 ) {
@@ -529,7 +530,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() {
 
@@ -906,8 +907,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
      */

includes/class-sensei-learners.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-lesson.php

Doc Comments +2 added lines, -2 removed lines

@@ -239,7 +239,7 @@ 
 	 *
 	 * @access public
 	 * @param int $post_id
-	 * @return void
+	 * @return integer|null
 	 */
 	public function meta_box_save ( $post_id ) {
 
@@ -2418,7 +2418,7 @@ 
 	 *
 	 * @access private
 	 * @param array $data (default: array())
-	 * @return void
+	 * @return boolean
 	 */
 	private function lesson_delete_question( $data = array() ) {
 

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