gravityview / GravityView

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() ) );

includes/class-frontend-views.php

Doc Comments +5 added lines, -5 removed lines

@@ -150,7 +150,7 @@ 
 
 	/**
 	 * Sets the single entry ID and also the entry
-	 * @param bool|int $single_entry
+	 * @param boolean|string $single_entry
 	 */
 	public function setSingleEntry( $single_entry ) {
 
@@ -167,7 +167,7 @@ 
 
 	/**
 	 * Set the current entry
-	 * @param array|int $entry Entry array or entry ID
+	 * @param boolean|string $entry Entry array or entry ID
 	 */
 	public function setEntry( $entry ) {
 
@@ -225,7 +225,7 @@ 
 	 *
 	 *
 	 *
-	 * @param null $view_id
+	 * @param string $view_id
 	 */
 	public function set_context_view_id( $view_id = null ) {
 
@@ -934,7 +934,7 @@ 
 	 *
 	 * @uses  gravityview_get_entries()
 	 * @access public
-	 * @param array $args\n
+	 * @param array $args
 	 *   - $id - View id
 	 *   - $page_size - Page
 	 *   - $sort_field - form field id to sort
@@ -1364,7 +1364,7 @@ 
 	/**
 	 * Checks if field (column) is sortable
 	 *
-	 * @param string $field Field settings
+	 * @param string $field_id Field settings
 	 * @param array $form Gravity Forms form array
 	 *
 	 * @since 1.7

includes/class-gravityview-admin-duplicate-view.php

Doc Comments +1 added lines, -1 removed lines

@@ -195,7 +195,7 @@
 	 *
 	 * @since 1.6
 	 *
-	 * @param int $new_view_id The ID of the newly created View
+	 * @param int $new_id The ID of the newly created View
 	 * @param WP_Post $post The View that was just cloned
 	 *
 	 * @return void

includes/class-gravityview-compatibility.php

Doc Comments +1 added lines, -1 removed lines

@@ -116,7 +116,7 @@
 
 	/**
 	 * @since 1.12
-	 * @return bool
+	 * @return boolean|null
 	 */
 	private function add_fallback_shortcode() {
 

includes/class-gravityview-entry-link-shortcode.php

Doc Comments +1 added lines, -2 removed lines

@@ -221,7 +221,6 @@ 
 	 *
 	 * @since 1.15
 	 *
-	 * @param string|null $content Content inside shortcode, if defined
 	 *
 	 * @return string|boolean If URL is fetched, the URL to the entry link. If not found, returns false.
 	 */
@@ -316,7 +315,7 @@ 
 	 *
 	 * @since 1.15
 	 *
-	 * @param string $href URL
+	 * @param string|null $url
 	 */
 	private function maybe_add_field_values_query_args( $url ) {
 

includes/class-gravityview-extension.php

Doc Comments +1 added lines, -1 removed lines

@@ -278,7 +278,7 @@
 
 	/**
 	 * Add a notice to be displayed in the admin.
-	 * @param array $notice Array with `class` and `message` keys. The message is not escaped.
+	 * @param string $notice Array with `class` and `message` keys. The message is not escaped.
 	 */
 	public static function add_notice( $notice = array() ) {
 

includes/class-gravityview-merge-tags.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-roles-capabilities.php

Doc Comments -1 removed lines

@@ -67,7 +67,6 @@
 	 *
 	 * @since 1.15
 	 *
-	 * @param array   $allcaps An array of all the user's capabilities.
 	 * @param array   $caps    Actual capabilities for meta capability.
 	 * @param array   $args    Optional parameters passed to has_cap(), typically object ID.
 	 * @param WP_User|null $user    The user object, in WordPress 3.7.0 or higher