gravityview / GravityView

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/fields/class-gravityview-field.php

Doc Comments +1 added lines, -1 removed lines

@@ -135,7 +135,7 @@
 	 * @param bool $url_encode Whether to URL-encode output
 	 * @param bool $esc_html Whether to apply `esc_html()` to output
 	 *
-	 * @return mixed
+	 * @return string
 	 */
 	public static function replace_gv_merge_tags(  $text, $form = array(), $entry = array(), $url_encode = false, $esc_html = false ) {
 

includes/class-gravityview-settings.php

Doc Comments +1 added lines

@@ -301,6 +301,7 @@
 	 * Make protected public
 	 * @inheritDoc
 	 * @access public
+	 * @param string $setting_name
 	 */
 	public function get_app_setting( $setting_name ) {
 

includes/fields/class-gravityview-fields.php

Doc Comments +1 added lines, -2 removed lines

@@ -77,7 +77,7 @@ 
 	/**
 	 * Alias for get_instance()
 	 *
-	 * @param $field_name
+	 * @param string $field_name
 	 *
 	 * @return GravityView_Field|false
 	 */
@@ -88,7 +88,6 @@ 
 	/**
 	 * Alias for get_instance()
 	 *
-	 * @param string|GF_Field $field_name Gravity Forms field class or the class name type
 	 *
 	 * @return GravityView_Field
 	 */

includes/class-api.php

Doc Comments +1 added lines, -2 removed lines

@@ -214,7 +214,6 @@ 
 	 *
 	 * @access public
 	 * @param array $entry
-	 * @param array $field
 	 * @return null|string
 	 */
 	public static function field_value( $entry, $field_settings, $format = 'html' ) {
@@ -1000,7 +999,7 @@ 
  * Get the current View ID being rendered
  *
  * @global GravityView_View $gravityview_view
- * @return string View context "directory" or "single"
+ * @return integer View context "directory" or "single"
  */
 function gravityview_get_view_id() {
 	return GravityView_View::getInstance()->getViewId();

includes/class-template.php

Doc Comments +3 added lines

@@ -220,6 +220,9 @@
 
 	}
 
+	/**
+	 * @param string $key
+	 */
 	public function getCurrentFieldSetting( $key ) {
 		$settings = $this->getCurrentField('field_settings');
 

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