pods-framework / pods

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

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
 	 */

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