pods-framework / pods

components/Pages.php

Doc Comments +2 added lines, -2 removed lines

@@ -134,7 +134,7 @@ 
      * Disable this Post Type from appearing in the Builder layouts list
      *
      * @param array $post_types
-     * @return array
+     * @return string[]
      */
     public function disable_builder_layout ( $post_types ) {
         $post_types[] = $this->object_type;
@@ -621,7 +621,7 @@ 
      *
      * @param string $uri The Pod Page URI to check if exists
      *
-     * @return array|bool
+     * @return boolean
      */
     public static function exists ( $uri = null ) {
         if ( null === $uri ) {

components/Templates/class-pods_templates.php

Doc Comments +11 added lines

@@ -289,6 +289,8 @@ 
 	/**
 	 * create and register an instance ID
 	 *
+	 * @param string $id
+	 * @param string $process
 	 */
 	public function element_instance_id( $id, $process ) {
 
@@ -456,6 +458,11 @@ 
 	 * Get the current URL
 	 *
 	 */
+
+	/**
+	 * @param string $src
+	 * @param string $path
+	 */
 	static function get_url( $src = null, $path = null ) {
 
 		if ( !empty( $path ) ) {
@@ -469,6 +476,10 @@ 
 	 * Get the current URL
 	 *
 	 */
+
+	/**
+	 * @param string $src
+	 */
 	static function get_path( $src = null ) {
 
 		return plugin_dir_path( $src );

components/Templates/includes/auto-template/Pods_Templates_Auto_Template_Settings.php

Doc Comments +1 added lines, -1 removed lines

@@ -224,7 +224,7 @@
 	 *
 	 * @param bool	$load_in_admin Optional. Whether to load in admin. Default is false.
 	 *
-	 * @return Pods_PFAT_Frontend
+	 * @return Pods_Templates_Auto_Template_Front_End|null
 	 *
 	 * @since 2.5.5
 	 */

components/Templates/includes/functions-view_template.php

Doc Comments +1 added lines, -1 removed lines

@@ -219,7 +219,7 @@
  * @param array attributes from template
  * @param string template to be processed
  *
- * @return null
+ * @return string
  * @since 2.4
  */
 function frontier_do_subtemplate( $atts, $content ) {

deprecated/classes/Pods.php

Doc Comments +2 added lines, -2 removed lines

@@ -19,7 +19,7 @@ 
     /**
      * Constructor - Pods Deprecated functionality (pre 2.0)
      *
-     * @param object $obj The Pods object
+     * @param Pods $obj The Pods object
      * @license http://www.gnu.org/licenses/gpl-2.0.html
      * @since 2.0
      */
@@ -603,7 +603,7 @@ 
     /**
      * Run a helper within a Pod Page or WP Template
      *
-     * @param string $helper The helper name
+     * @param string $helper_name The helper name
      *
      * @return mixed Anything returned by the helper
      * @since 1.2.0

deprecated/classes/PodsAPI.php

Doc Comments +1 added lines, -1 removed lines

@@ -21,7 +21,7 @@
     /**
      * Constructor - PodsAPI Deprecated functionality (pre 2.0)
      *
-     * @param object $obj The PodsAPI object
+     * @param PodsAPI $obj The PodsAPI object
      *
      * @license http://www.gnu.org/licenses/gpl-2.0.html
      * @since 2.0

deprecated/deprecated.php

Doc Comments +2 added lines, -2 removed lines

@@ -358,7 +358,7 @@ 
  * @param string $message
  * @param bool $error Whether or not it is an error message
  *
- * @return bool
+ * @return boolean|null
  *
  * @since 1.12
  * @deprcated 2.3
@@ -374,7 +374,7 @@ 
  *
  * @param string $message
  *
- * @return bool
+ * @return boolean|null
  *
  * @since 1.12
  * @deprcated 2.3

includes/data.php

Doc Comments +2 added lines, -5 removed lines

@@ -847,7 +847,7 @@ 
  *
  * @param mixed $value The value to be set
  * @param mixed $var The variable name, or URI segment position / query var name (if $type is 'url')
- * @param string|array|object $type (optional) Super globals, url/url-relative, constants, globals, user data, Pod field values
+ * @param string $type (optional) Super globals, url/url-relative, constants, globals, user data, Pod field values
  *
  * @return mixed Updated URL (if $type is 'url'), $value (if $type is 'constant'), Item ID (if $type is 'pods'), $type, or false if not set
  * @since 2.3.10
@@ -1210,7 +1210,7 @@ 
 /**
  * Create a slug from an input string
  *
- * @param $orig
+ * @param string $orig
  *
  * @return string Sanitized slug
  *
@@ -1905,7 +1905,6 @@ 
  *
  * @param array|object $list List of items
  * @param array $args Array of index, parent, children, id, and prefix keys to use
- * @param string $children_key Key to recurse children into
  *
  * @return array|object
  * @since 2.3
@@ -1939,9 +1938,7 @@ 
 /**
  * Recurse list of hierarchical data
  *
- * @param array|object $list List of items
  * @param array $args Array of children and prefix keys to use
- * @param string $children_key Key to recurse children into
  *
  * @see pods_hierarchical_select
  * @return array

includes/general.php

Doc Comments +3 added lines, -4 removed lines

@@ -310,7 +310,6 @@ 
 /**
  * Determine if Deprecated Mode is enabled
  *
- * @param bool $include_debug Whether to include strict mode
  *
  * @return bool Whether Deprecated Mode is enabled
  *
@@ -443,6 +442,7 @@ 
  * @param string $minimum_version Minimum version
  * @param string $comparison Comparison operator
  * @param string $maximum_version Maximum version
+ * @param string $what
  *
  * @return bool
  */
@@ -906,7 +906,7 @@ 
  * @uses get_shortcode_regex() Gets the search pattern for searching shortcodes.
  *
  * @param string $content Content to search for shortcodes
- * @param array $shortcodes Array of shortcodes to run
+ * @param string[] $shortcodes Array of shortcodes to run
  * @return string Content with shortcodes filtered out.
  */
 function pods_do_shortcode( $content, $shortcodes ) {
@@ -1446,7 +1446,7 @@ 
  * @param string|bool $key Key for the cache
  * @param string $group (optional) Key for the group
  *
- * @return bool|mixed|null|void
+ * @return boolean
  *
  * @since 2.0
  */
@@ -1654,7 +1654,6 @@ 
  *
  * @param string|array $pod The pod name or array of pod names
  * @param string $name The name of the Pod
- * @param array $object (optional) Pod array, including any 'fields' arrays
  *
  * @return array|boolean Field data or false if unsuccessful
  * @since 2.1