gravityview / GravityView

includes/fields/class-gravityview-field.php

Doc Comments +4 added lines, -4 removed lines

@@ -177,10 +177,10 @@
 	 * </pre>
 	 *
 	 * @param  [type]      $field_options [description]
-	 * @param  [type]      $template_id   [description]
-	 * @param  [type]      $field_id      [description]
-	 * @param  [type]      $context       [description]
-	 * @param  [type]      $input_type    [description]
+	 * @param  string      $template_id   [description]
+	 * @param  string      $field_id      [description]
+	 * @param  string      $context       [description]
+	 * @param  string      $input_type    [description]
 	 * @return [type]                     [description]
 	 */
 	function field_options( $field_options, $template_id, $field_id, $context, $input_type ) {

includes/fields/list.php

Doc Comments +1 added lines, -1 removed lines

@@ -25,7 +25,7 @@
 	 *
 	 * @param GF_Field_List $field Gravity Forms field
 	 * @param string|array $field_value Serialized or unserialized array value for the field
-	 * @param int|string $column_id The numeric key of the column (0-index) or the label of the column
+	 * @param integer $column_id The numeric key of the column (0-index) or the label of the column
 	 * @param string $format If set to 'raw', return an array of values for the column. Otherwise, allow Gravity Forms to render using `html` or `text`
 	 *
 	 * @return array|string|null Returns null if the $field_value passed wasn't an array or serialized array

includes/helper-functions.php

Doc Comments +3 added lines, -4 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.
  */
@@ -101,7 +101,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 ) {
@@ -276,7 +276,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 ) {
@@ -296,7 +295,7 @@ 
  * Checks whether `false`, `null`, empty string, empty array, object with no vars defined
  *
  * @since 1.15.1
- * @param  mixed  $value Check whether this is empty
+ * @param  string  $value Check whether this is empty
  * @param boolean $zero_is_empty Should the number zero be treated as an empty value?
  * @param boolean $allow_string_booleans Whether to check if 'yes', 'true' => `true` and 'no', 'false' => `false`
  * @return boolean        True: empty; false: not empty

includes/lib/EDD_SL_Plugin_Updater.php

Doc Comments +1 added lines, -1 removed lines

@@ -68,7 +68,7 @@
 	 * @uses api_request()
 	 *
 	 * @param array   $_transient_data Update array build by WordPress.
-	 * @return array Modified update array with custom plugin data.
+	 * @return stdClass Modified update array with custom plugin data.
 	 */
 	function check_update( $_transient_data ) {
 

includes/lib/xml-parsers/parsers.php

Doc Comments +22 added lines

@@ -10,6 +10,10 @@ 
  * WordPress Importer class for managing parsing of WXR files.
  */
 class WXR_Parser {
+
+	/**
+	 * @param string $file
+	 */
 	function parse( $file ) {
 		// Attempt to use proper XML parsers first
 		if ( extension_loaded( 'simplexml' ) ) {
@@ -479,6 +483,9 @@ 
 		);
 	}
 
+	/**
+	 * @param string $tag
+	 */
 	function get_tag( $string, $tag ) {
 		preg_match( "|<$tag.*?>(.*?)</$tag>|is", $string, $return );
 		if ( isset( $return[1] ) ) {
@@ -500,6 +507,9 @@ 
 		return $return;
 	}
 
+	/**
+	 * @param string $c
+	 */
 	function process_category( $c ) {
 		return array(
 			'term_id' => $this->get_tag( $c, 'wp:term_id' ),
@@ -510,6 +520,9 @@ 
 		);
 	}
 
+	/**
+	 * @param string $t
+	 */
 	function process_tag( $t ) {
 		return array(
 			'term_id' => $this->get_tag( $t, 'wp:term_id' ),
@@ -519,6 +532,9 @@ 
 		);
 	}
 
+	/**
+	 * @param string $t
+	 */
 	function process_term( $t ) {
 		return array(
 			'term_id' => $this->get_tag( $t, 'wp:term_id' ),
@@ -530,6 +546,9 @@ 
 		);
 	}
 
+	/**
+	 * @param string $a
+	 */
 	function process_author( $a ) {
 		return array(
 			'author_id' => $this->get_tag( $a, 'wp:author_id' ),
@@ -541,6 +560,9 @@ 
 		);
 	}
 
+	/**
+	 * @param string $post
+	 */
 	function process_post( $post ) {
 		$post_id        = $this->get_tag( $post, 'wp:post_id' );
 		$post_title     = $this->get_tag( $post, 'title' );

includes/plugin-and-theme-hooks/abstract-gravityview-plugin-and-theme-hooks.php

Doc Comments -1 removed lines

@@ -169,7 +169,6 @@
 	 *
 	 * @since 1.15.2
 	 *
-	 * @param array $handles Array of meta keys to check for existence of shortcodes
 	 * @param int $post_id The ID being checked by GravityView
 	 *
 	 * @return array Meta key array, merged with existing meta keys

includes/widgets/class-gravityview-widget.php

Doc Comments +3 added lines

@@ -51,6 +51,9 @@
 	// hold widget View options
 	private $widget_options;
 
+	/**
+	 * @param string $widget_id
+	 */
 	function __construct( $widget_label , $widget_id , $defaults = array(), $settings = array() ) {
 
 

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

Doc Comments +1 added lines, -1 removed lines

@@ -993,7 +993,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/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 string $form_id
 	 *
 	 * @return array $entries Multidimensional array of Gravity Forms entries
 	 */