gravityview / GravityView

includes/admin/metaboxes/class-gravityview-admin-metaboxes.php

Doc Comments +1 added lines, -2 removed lines

@@ -214,7 +214,7 @@ 
 	/**
 	 * Generate the script tags necessary for the Gravity Forms Merge Tag picker to work.
 	 *
-	 * @param  mixed      $curr_form Form ID
+	 * @param  string      $curr_form Form ID
 	 * @return null|string     Merge tags html; NULL if $curr_form isn't defined.
 	 */
 	public static function render_merge_tags_scripts( $curr_form ) {
@@ -290,7 +290,6 @@ 
 	 * Render shortcode hint in the Publish metabox
 	 *
 	 * @access public
-	 * @param object $post
 	 * @return void
 	 */
 	function render_shortcode_hint() {

includes/admin/metaboxes/class-gravityview-metabox-tab.php

Doc Comments +1 added lines, -1 removed lines

@@ -95,7 +95,7 @@
 	 * @param string $icon_class_name Icon class used in vertical tabs. Supports non-dashicon. If dashicons, no need for `dashicons ` prefix
 	 * @param string $callback Function to render the metabox, if $file is not defined.
 	 * @param null $callback_args Arguments passed to the callback
-	 * @return void
+	 * @return GravityView_Metabox_Tab
 	 */
 	function __construct( $id, $title = '', $file = '', $icon_class_name = '', $callback = '', $callback_args = null  ) {
 

includes/class-admin-add-shortcode.php

Doc Comments -1 removed lines

@@ -144,7 +144,6 @@
 	 * Enqueue scripts and styles
 	 *
 	 * @access public
-	 * @param mixed $hook
 	 * @return void
 	 */
 	function add_scripts_and_styles() {

includes/class-admin-approve-entries.php

Doc Comments +3 added lines, -4 removed lines

@@ -170,7 +170,7 @@ 
 	 *
 	 * @uses  GravityView_frontend::get_search_criteria() Convert the $_POST search request into a properly formatted request.
 	 * @access public
-	 * @return void|boolean
+	 * @return null|false
 	 */
 	public function process_bulk_action() {
 		if ( ! class_exists( 'RGForms' ) ) {
@@ -252,7 +252,7 @@ 
 	 * @param array|boolean $entries If array, array of entry IDs that are to be updated. If true: update all entries.
 	 * @param int $approved Approved status. If `0`: unapproved, if not empty, `Approved`
 	 * @param int $form_id The Gravity Forms Form ID
-	 * @return boolean|void
+	 * @return false|null
 	 */
 	private static function update_bulk( $entries, $approved, $form_id ) {
 
@@ -284,7 +284,6 @@ 
 	 *
 	 * @access public
 	 * @static
-	 * @param int $lead_id (default: 0)
 	 * @param int $approved (default: 0)
 	 * @param int $form_id (default: 0)
 	 * @param int $approvedcolumn (default: 0)
@@ -470,7 +469,7 @@ 
 	 * @access public
 	 * @static
 	 * @param mixed $form GF Form or Form ID
-	 * @return false|null|string Returns the input ID of the approved field. Returns NULL if no approved fields were found. Returns false if $form_id wasn't set.
+	 * @return integer Returns the input ID of the approved field. Returns NULL if no approved fields were found. Returns false if $form_id wasn't set.
 	 */
 	static public function get_approved_column( $form ) {
 

includes/class-admin-views.php

Doc Comments +7 added lines, -2 removed lines

@@ -326,7 +326,7 @@ 
 
 	/**
 	 * Get HTML links relating to a connected form, like Edit, Entries, Settings, Preview
-	 * @param  array|int $form_id Gravity Forms forms array, or the form ID
+	 * @param  array|int $form Gravity Forms forms array, or the form ID
 	 * @param  boolean $include_form_link Whether to include the bold name of the form in the output
 	 * @return string          HTML links
 	 */
@@ -547,7 +547,7 @@ 
 	 * $blacklist_field_types - contains the field types which are not proper to be shown in a directory.
 	 *
 	 * @access public
-	 * @param int $form_id Gravity Forms Form ID (default: '')
+	 * @param int $form Gravity Forms Form ID (default: '')
 	 * @param string $context (default: 'single')
 	 * @return void
 	 */
@@ -592,6 +592,10 @@ 
 		$this->render_additional_fields( $form, $context );
 	}
 
+	/**
+	 * @param string $form
+	 * @param string $context
+	 */
 	function render_additional_fields( $form, $context ) {
 
 		/**
@@ -790,6 +794,7 @@ 
 	 * @param  string $zone   Either 'single', 'directory', 'header', 'footer'
 	 * @param  array $rows    The layout structure: rows, columns and areas
 	 * @param  array $values  Saved objects
+	 * @param string $template_id
 	 * @return void
 	 */
 	function render_active_areas( $template_id, $type, $zone, $rows, $values ) {

includes/class-admin.php

Doc Comments +4 added lines, -1 removed lines

@@ -311,7 +311,7 @@ 
 	 * Remove any style or script non-registered in the no conflict mode
 	 * @todo  Move this to GravityView_Admin_Views
 	 * @param  WP_Dependencies $wp_objects        Object of WP_Styles or WP_Scripts
-	 * @param  array $required_objects   List of registered script/style handles
+	 * @param  string[] $required_objects   List of registered script/style handles
 	 * @param  string $type              Either 'styles' or 'scripts'
 	 * @return void
 	 */
@@ -472,6 +472,9 @@ 
 
 new GravityView_Admin;
 
+/**
+ * @param string $page
+ */
 function gravityview_is_admin_page($hook = '', $page = NULL) {
 	return GravityView_Admin::is_admin_page( $hook, $page );
 }

includes/class-ajax.php

Doc Comments +2 added lines, -2 removed lines

@@ -28,7 +28,7 @@ 
 	 * @since 1.15
 	 * @param bool|false $mixed
 	 *
-	 * @return bool
+	 * @return boolean|null
 	 */
 	private function _exit( $mixed = NULL ) {
 
@@ -200,7 +200,7 @@ 
 	 * Import Gravity Form XML or JSON
 	 *
 	 * @param  string $xml_or_json_path Path to form XML or JSON file
-	 * @return int|bool       Imported form ID or false
+	 * @return false|string       Imported form ID or false
 	 */
 	function import_form( $xml_or_json_path = '' ) {
 

includes/class-data.php

Doc Comments +5 added lines, -2 removed lines

@@ -113,6 +113,9 @@ 
 		return ( sizeof( $ids ) === 1 ) ? $ids[0] : $ids;
 	}
 
+	/**
+	 * @return GravityView_View_Data
+	 */
 	public static function getInstance( $passed_post = NULL ) {
 
 		if( empty( self::$instance ) ) {
@@ -152,7 +155,7 @@ 
 	 * within the WordPress database.
 	 *
 	 * @see http://tommcfarlin.com/wordpress-post-exists-by-id/ Fastest check available
-	 * @param    int    $id    The ID of the post to check
+	 * @param integer $view_id
 	 * @return   bool          True if the post exists; otherwise, false.
 	 * @since    1.0.0
 	 */
@@ -299,7 +302,7 @@ 
 	 *
 	 * @access public
 	 * @param array $properties
-	 * @return void|boolean (field should be hidden) or false (field should be presented)
+	 * @return boolean (field should be hidden) or false (field should be presented)
 	 */
 	private function hide_field_check_conditions( $properties ) {
 

includes/class-debug-bar.php

Doc Comments +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
 
 	/**
 	 * Should the panel be shown? If there are notices or warnings, yes.
-	 * @return boolean true: show panel; false: hide panel
+	 * @return boolean|null true: show panel; false: hide panel
 	 */
 	function set_visible( $visible = '' ) {
 		$this->_visible = ( count( $this->get_notices() ) || count( $this->get_warnings() ) );