pods-framework / pods

classes/fields/wysiwyg.php

Doc Comments -1 removed lines

@@ -193,7 +193,6 @@
      * @param mixed $value
      * @param string $name
      * @param array $options
-     * @param array $fields
      * @param array $pod
      * @param int $id
      *

classes/Pods.php

Doc Comments +7 added lines, -10 removed lines

@@ -330,7 +330,7 @@ 
 	/**
 	 * Rewind Iterator
 	 *
-	 * @return void|boolean
+	 * @return null|false
 	 *
 	 * @since 2.3.4
 	 *
@@ -381,7 +381,7 @@ 
 	/**
 	 * Move onto the next Iterator row
 	 *
-	 * @return void|boolean
+	 * @return null|false
 	 *
 	 * @since 2.3.4
 	 *
@@ -475,7 +475,7 @@ 
 	/**
 	 * Return field array from a Pod, a field's data, or a field option
 	 *
-	 * @param null $field
+	 * @param string $field
 	 * @param null $option
 	 *
 	 * @return bool|mixed
@@ -1927,7 +1927,6 @@ 
 	 * Return the next item ID, loops at the first id to return the last
 	 *
 	 * @param int $id
-	 * @param array $find_params
 	 *
 	 * @return int
 	 * @since 2.0
@@ -2443,7 +2442,7 @@ 
 	 * @param null|int $offset Offset of rows
 	 * @param null|int $total Total rows
 	 *
-	 * @return int Number of pages
+	 * @return double Number of pages
 	 * @since 2.3.10
 	 */
 	public function total_pages( $limit = null, $offset = null, $total = null ) {
@@ -2552,7 +2551,7 @@ 
 	 * @see PodsAPI::save_pod_item
 	 *
 	 * @param string $field Field name
-	 * @param mixed $value ID(s) to add, int|float to add to number field, string for dates (+1 week), or string for text
+	 * @param string $value ID(s) to add, int|float to add to number field, string for dates (+1 week), or string for text
 	 * @param int $id (optional) ID of the pod item to update
 	 *
 	 * @return int The item ID
@@ -2658,7 +2657,7 @@ 
 	 * @see PodsAPI::save_pod_item
 	 *
 	 * @param string $field Field name
-	 * @param mixed $value ID(s) to add, int|float to add to number field, string for dates (-1 week), or string for text
+	 * @param string $value ID(s) to add, int|float to add to number field, string for dates (-1 week), or string for text
 	 * @param int $id (optional) ID of the pod item to update
 	 *
 	 * @return int The item ID
@@ -3261,7 +3260,7 @@ 
 	 *
 	 * @see Pods_Templates::template
 	 *
-	 * @param string $template The template name
+	 * @param string $template_name The template name
 	 * @param string $code Custom template code to use instead
 	 * @param bool $deprecated Whether to use deprecated functionality based on old function usage
 	 *
@@ -3547,7 +3546,6 @@ 
 	 * Replace magic tags with their values
 	 *
 	 * @param string $code The content to evaluate
-	 * @param object $obj The Pods object
 	 *
 	 * @return string Code with Magic Tags evaluated
 	 *
@@ -3561,7 +3559,6 @@ 
 	 * Replace magic tags with their values
 	 *
 	 * @param string $tag The magic tag to process
-	 * @param object $obj The Pods object
 	 *
 	 * @return string Code with Magic Tags evaluated
 	 *

classes/PodsArray.php

Doc Comments +1 added lines, -1 removed lines

@@ -92,7 +92,7 @@
     /**
      * Validate value on a specific type and set default (if empty)
      *
-     * @param mixed $offset Used to get value of Array or Variable on Object
+     * @param string $offset Used to get value of Array or Variable on Object
      * @param mixed $default Used to set default value if it doesn't exist
      * @param string $type Used to force a specific type of variable (allowed: array, object, integer, absint, boolean)
      * @param mixed $extra Used in advanced types of variables

classes/PodsData.php

Doc Comments +3 added lines, -3 removed lines

@@ -2019,8 +2019,8 @@ 
      *
      * @param string|array $sql The SQL to execute
      * @param string $error Error to throw on problems
-     * @param null $results_error (optional)
-     * @param null $no_results_error (optional)
+     * @param string|null $results_error (optional)
+     * @param string|null $no_results_error (optional)
      *
      * @return array|bool|mixed|null|void Result of the query
      *
@@ -2347,7 +2347,7 @@ 
     /**
      * Get the string to use in a query for matching, uses WP_Query meta_query arguments
      *
-     * @param string|int $field Field name or array index
+     * @param string $field Field name or array index
      * @param array|string $q Query array (meta_query) or string for matching
      * @param array $pod Related Pod
 	 * @param object $params Parameters passed from select()

classes/PodsMeta.php

Doc Comments +9 added lines, -3 removed lines

@@ -332,6 +332,9 @@ 
         self::$settings = pods_api()->load_pods( array( 'type' => 'settings', 'refresh' => true ) );
     }
 
+    /**
+     * @param string $type
+     */
     public function register ( $type, $pod ) {
         $pod_type = $type;
 
@@ -795,7 +798,7 @@ 
     }
 
     /**
-     * @param $type
+     * @param string $type
      * @param $name
      * @param $default_fields
      *
@@ -2688,7 +2691,7 @@ 
      * @param string $meta_value
      * @param bool $unique
      *
-     * @return bool|int|null
+     * @return null|integer
      */
     public function add_meta ( $object_type, $_null = null, $object_id = 0, $meta_key = '', $meta_value = '', $unique = false ) {
         if ( pods_tableless() )
@@ -2729,7 +2732,7 @@ 
      * @param string $meta_value
      * @param string $prev_value
      *
-     * @return bool|int|null
+     * @return null|integer
      */
     public function update_meta ( $object_type, $_null = null, $object_id = 0, $meta_key = '', $meta_value = '', $prev_value = '' ) {
         if ( pods_tableless() )
@@ -2870,6 +2873,9 @@ 
         return $this->delete_object( 'media', $id );
     }
 
+    /**
+     * @param string $type
+     */
     public function delete_object ( $type, $id, $name = null ) {
         if ( empty( $name ) )
             $name = $type;

classes/PodsMigrate.php

Doc Comments +2 added lines, -2 removed lines

@@ -457,7 +457,7 @@ 
      * @param array $data Array of data
      * @param string $delimiter Delimiter for export type 'sv'
      *
-     * @return bool
+     * @return false|string
      */
     public function build_sv ( $data = null, $delimiter = null ) {
         if ( !empty( $data ) )
@@ -521,7 +521,7 @@ 
     /**
      * @param array $data Array of data
      *
-     * @return bool
+     * @return false|string
      */
     public function build_xml ( $data = null ) {
         if ( !empty( $data ) )

components/Helpers.php

Doc Comments +1 added lines, -1 removed lines

@@ -359,7 +359,7 @@
      * $params['name'] string Field name
      *
      * @param array $params An associative array of parameters
-     * @param null $obj
+     * @param Pods $obj
      *
      * @return mixed Anything returned by the helper
      * @since 2.0

components/Markdown.php

Doc Comments +10 added lines

@@ -1018,6 +1018,10 @@ 
 
 	var $list_level = 0;
 
+	/**
+	 * @param string $list_str
+	 * @param string $marker_any_re
+	 */
 	function processListItems($list_str, $marker_any_re) {
 	#
 	#	Process the contents of a single ordered or unordered list, splitting it
@@ -1121,6 +1125,9 @@ 
 	}
 
 
+	/**
+	 * @param string $code
+	 */
 	function makeCodeSpan($code) {
 	#
 	# Create a code span markup for $code. Called from handleSpanToken.
@@ -1613,6 +1620,9 @@ 
 	# hanlde UTF-8 if the default function does not exist.
 	var $utf8_strlen = 'mb_strlen';
 
+	/**
+	 * @param string $text
+	 */
 	function detab($text) {
 	#
 	# Replace tabs with the appropriate amount of space.

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 ) {