gravityview / GravityView

includes/admin/class.field.type.php

Doc Comments +1 added lines

@@ -158,6 +158,7 @@
     /**
      * important! Override this class if needed
      * outputs the field setting html
+     * @param string $override_input
      */
     function render_setting( $override_input = NULL ) {
 

includes/helper-functions.php

Doc Comments +2 added lines, -3 removed lines

@@ -28,7 +28,7 @@ 
  *
  * We could do this in a cleaner fashion, but this prevents a lot of code duplication, checking for URL structure, etc.
  *
- * @param int|WP_Post $id        Optional. Post ID or post object. Default current post.
+ * @param integer $id        Optional. Post ID or post object. Default current post.
  *
  * @return array URL args, if exists. Empty array if not.
  */
@@ -135,7 +135,7 @@ 
  * @since 1.15 Added $object param
  *
  * @param string $file_path Full path to a file
- * @param mixed $object Pass pseudo-global to the included file
+ * @param GravityView_Edit_Entry_Render $object Pass pseudo-global to the included file
  * @return string Included file contents
  */
 function gravityview_ob_include( $file_path, $object = NULL ) {
@@ -310,7 +310,6 @@ 
  * Do a _very_ basic match for second-level TLD domains, like `.co.uk`
  *
  * Ideally, we'd use https://github.com/jeremykendall/php-domain-parser to check for this, but it's too much work for such a basic functionality. Maybe if it's needed more in the future. So instead, we use [Basic matching regex](http://stackoverflow.com/a/12372310).
- * @param  string $domain Domain to check if it's a TLD or subdomain
  * @return string         Extracted domain if it has a subdomain
  */
 function _gravityview_strip_subdomain( $string_maybe_has_subdomain ) {

includes/extensions/entry-notes/class-gravityview-field-notes.php

Doc Comments +3 added lines, -3 removed lines

@@ -316,7 +316,7 @@ 
 	 *
 	 * @param array $file_paths List of template paths ordered
 	 *
-	 * @return array File paths with `./` and `./partials/` paths added
+	 * @return string[] File paths with `./` and `./partials/` paths added
 	 */
 	public function add_template_path( $file_paths ) {
 
@@ -485,7 +485,7 @@ 
 	 * @param array $entry
 	 * @param array $data Note details array
 	 *
-	 * @return int|WP_Error
+	 * @return integer
 	 */
 	private function add_note( $entry, $data ) {
 		global $current_user, $wpdb;
@@ -584,7 +584,7 @@ 
 	 *
 	 * @since 1.17
 	 *
-	 * @param int|string $entry_slug Current entry unique ID
+	 * @param string $entry_slug Current entry unique ID
 	 *
 	 * @return string HTML output
 	 */

includes/wordpress-widgets/class-gravityview-recent-entries-widget.php

Doc Comments +1 added lines

@@ -176,6 +176,7 @@
 	 * Get the entries that will be shown in the current widget
 	 *
 	 * @param  array $instance Settings for the current widget
+	 * @param false|string $form_id
 	 *
 	 * @return array $entries Multidimensional array of Gravity Forms entries
 	 */

includes/widgets/search-widget/class-search-widget.php

Doc Comments +4 added lines, -4 removed lines

@@ -201,7 +201,7 @@ 
 	/**
 	 * Add admin script to the no-conflict scripts whitelist
 	 * @param array $allowed Scripts allowed in no-conflict mode
-	 * @return array Scripts allowed in no-conflict mode, plus the search widget script
+	 * @return string[] Scripts allowed in no-conflict mode, plus the search widget script
 	 */
 	public function register_no_conflict( $allowed ) {
 		$allowed[] = 'gravityview_searchwidget_admin';
@@ -889,7 +889,7 @@ 
 	/**
 	 * Get the label for a search form field
 	 * @param  array $field      Field setting as sent by the GV configuration - has `field`, `input` (input type), and `label` keys
-	 * @param  array $form_field Form field data, as fetched by `gravityview_get_field()`
+	 * @param  GF_Field|null $form_field Form field data, as fetched by `gravityview_get_field()`
 	 * @return string             Label for the search form
 	 */
 	private static function get_field_label( $field, $form_field = array() ) {
@@ -1058,7 +1058,7 @@ 
 	/**
 	 * Require the datepicker script for the frontend GV script
 	 * @param array $js_dependencies Array of existing required scripts for the fe-views.js script
-	 * @return array Array required scripts, with `jquery-ui-datepicker` added
+	 * @return string[] Array required scripts, with `jquery-ui-datepicker` added
 	 */
 	public function add_datepicker_js_dependency( $js_dependencies ) {
 
@@ -1070,7 +1070,7 @@ 
 	/**
 	 * Modify the array passed to wp_localize_script()
 	 *
-	 * @param array $js_localization The data padded to the Javascript file
+	 * @param array $localizations The data padded to the Javascript file
 	 * @param array $view_data View data array with View settings
 	 *
 	 * @return array

includes/plugin-and-theme-hooks/class-gravityview-plugin-hooks-gravity-forms-survey.php

Doc Comments -1 removed lines

@@ -36,7 +36,6 @@
 	 * @since 1.16.4
 	 * @since 1.17 Moved to GravityView_Plugin_Hooks_Gravity_Forms_Survey class
 	 *
-	 * @param array $form
 	 *
 	 * @return array Form, with all fields set to `allowsPrepopulate => true`
 	 */

includes/fields/class-gravityview-field-is-approved.php

Doc Comments -1 removed lines

@@ -59,7 +59,6 @@
 	 *
 	 * @param string $output HTML value output
 	 * @param array  $entry The GF entry array
-	 * @param array  $field_settings Settings for the particular GV field
 	 * @param array  $field Field array, as fetched from GravityView_View::getCurrentField()
 	 *
 	 * @return string The field setting label for the current status. Uses defaults, if not configured.

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 array $callback_args Arguments passed to the callback
-	 * @return void
+	 * @return GravityView_Metabox_Tab
 	 */
 	function __construct( $id, $title = '', $file = '', $icon_class_name = '', $callback = '', $callback_args = array()  ) {
 

includes/class-gravityview-entry-approval.php

Doc Comments +2 added lines, -2 removed lines

@@ -371,7 +371,7 @@ 
 	 * @param  int $entry_id ID of the Gravity Forms entry
 	 * @param  string $status String whether entry is approved or not. `0` for not approved, `Approved` for approved.
 	 * @param int $form_id ID of the form of the entry being updated. Improves query performance.
-	 * @param string $approvedcolumn Gravity Forms Field ID
+	 * @param integer $approvedcolumn Gravity Forms Field ID
 	 *
 	 * @return true|WP_Error
 	 */
@@ -424,7 +424,7 @@ 
 	 *
 	 * @since 1.19
 	 *
-	 * @param array|int $form Form ID or form array
+	 * @param integer $form Form ID or form array
 	 * @param string $approved_column Approved column field ID
 	 *
 	 * @return string|null