gravityview / GravityView

includes/class-common.php

Doc Comments +1 added lines, -2 removed lines

@@ -167,7 +167,6 @@ 
 	 * Returns the list of available forms
 	 *
 	 * @access public
-	 * @param mixed $form_id
 	 * @return array Empty array if GFAPI isn't available or no forms. Otherwise, associative array with id, title keys
 	 */
 	public static function get_forms() {
@@ -188,7 +187,7 @@ 
 	 * Return array of fields' id and label, for a given Form ID
 	 *
 	 * @access public
-	 * @param string|array $form_id (default: '') or $form object
+	 * @param string|array $form (default: '') or $form object
 	 * @return array
 	 */
 	public static function get_form_fields( $form = '', $add_default_properties = false, $include_parent_field = true ) {

includes/fields/class-gravityview-field.php

Doc Comments +6 added lines, -6 removed lines

@@ -175,7 +175,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 function replace_merge_tag( $matches = array(), $text = '', $form = array(), $entry = array(), $url_encode = false, $esc_html = false ) {
 
@@ -202,7 +202,7 @@ 
 	 *
 	 * @since 1.8.4
 	 *
-	 * @param array $existing_merge_tags
+	 * @param array $custom_merge_tags
 	 * @param int $form_id GF Form ID
 	 * @param GF_Field[] $fields Array of fields in the form
 	 * @param string $element_id The ID of the input that Merge Tags are being used on
@@ -341,10 +341,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/class-gravityview-fields.php

Doc Comments +1 added lines, -1 removed lines

@@ -77,7 +77,7 @@
 	/**
 	 * Alias for get_instance()
 	 *
-	 * @param $field_name
+	 * @param string $field_name
 	 *
 	 * @return GravityView_Field
 	 */

includes/fields/class-gravityview-field-transaction-type.php

Doc Comments +1 added lines, -1 removed lines

@@ -69,7 +69,7 @@
 	 *
 	 * @since 1.16
 	 *
-	 * @param int|string $value Number value for the field
+	 * @param string $value Number value for the field
 	 *
 	 * @return string Based on $value; `1`: "One-Time Payment"; `2`: "Subscription"
 	 */

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/admin/metaboxes/class-gravityview-admin-metaboxes.php

Doc Comments -1 removed lines

@@ -291,7 +291,6 @@
 	 * Render shortcode hint in the Publish metabox
 	 *
 	 * @access public
-	 * @param object $post
 	 * @return void
 	 */
 	function render_shortcode_hint() {

includes/class-admin-approve-entries.php

Doc Comments +3 added lines, -3 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 ) {
 
@@ -470,7 +470,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.php

Doc Comments +1 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
 	 */

includes/class-data.php

Doc Comments +3 added 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 ) ) {