htmlburger / carbon-fields

core/Container/Term_Meta_Container.php

Doc Comments +2 added lines, -2 removed lines

@@ -187,7 +187,7 @@ 
 	 * Show the container only on terms from the specified taxonomies.
 	 *
 	 * @param string|array $taxonomies
-	 * @return object $this
+	 * @return Term_Meta_Container $this
 	 **/
 	public function show_on_taxonomy( $taxonomies ) {
 		$taxonomies = (array) $taxonomies;
@@ -201,7 +201,7 @@ 
 	 * Show the container only on particular term level.
 	 *
 	 * @param int $term_level
-	 * @return object $this
+	 * @return Term_Meta_Container $this
 	 */
 	public function show_on_level( $term_level ) {
 		$this->settings['show_on_level'] = $term_level;

core/Container/Container.php

Doc Comments +3 added lines, -3 removed lines

@@ -499,7 +499,7 @@ 
 	 * Assign datastore instance for use by the container fields
 	 *
 	 * @param Datastore_Interface $datastore
-	 * @return object $this
+	 * @return Container $this
 	 **/
 	public function set_datastore( Datastore_Interface $datastore, $set_as_default = false ) {
 		if ( $set_as_default && !$this->has_default_datastore() ) {
@@ -723,7 +723,7 @@ 
 	 * assigned to them instead.
 	 *
 	 * @param array $fields
-	 * @return object $this
+	 * @return Container $this
 	 **/
 	public function add_fields( $fields ) {
 		foreach ( $fields as $field ) {
@@ -749,7 +749,7 @@ 
 	 *
 	 * @param string $tab_name
 	 * @param array $fields
-	 * @return object $this
+	 * @return Container $this
 	 */
 	public function add_tab( $tab_name, $fields ) {
 		$this->add_template( 'tabs', array( $this, 'template_tabs' ) );

core/Container/Nav_Menu_Item_Container.php

Doc Comments -1 removed lines

@@ -42,7 +42,6 @@
 	 * Perform instance initialization
 	 *
 	 * @param int $menu_item_id Used to pass the correct menu_item_id to the Container object
-	 * @param bool $render Whether the container will render the fields.
 	 */
 	public function init( $menu_item_id = 0 ) {
 		$this->get_datastore()->set_id( $menu_item_id );

core/Container/Post_Meta_Container.php

Doc Comments +10 added lines, -10 removed lines

@@ -342,7 +342,7 @@ 
 	 * Show the container only on particular page referenced by it's path.
 	 *
 	 * @param int|string $page page ID or page path
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 **/
 	public function show_on_page( $page ) {
 		$page_id = absint( $page );
@@ -368,7 +368,7 @@ 
 	 * Show the container only on pages whose parent is referenced by $parent_page_path.
 	 *
 	 * @param string $parent_page_path
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 **/
 	public function show_on_page_children( $parent_page_path ) {
 		$page = get_page_by_path( $parent_page_path );
@@ -390,7 +390,7 @@ 
 	 * @see show_on_taxonomy_term()
 	 *
 	 * @param string $category_slug
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 **/
 	public function show_on_category( $category_slug ) {
 		$this->settings['show_on']['category'] = $category_slug;
@@ -402,7 +402,7 @@ 
 	 * Show the container only on pages whose template has filename $template_path.
 	 *
 	 * @param string|array $template_path
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 **/
 	public function show_on_template( $template_path ) {
 		// Backwards compatibility where only pages support templates
@@ -427,7 +427,7 @@ 
 	 * Hide the container from pages whose template has filename $template_path.
 	 *
 	 * @param string|array $template_path
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 **/
 	public function hide_on_template( $template_path ) {
 		if ( is_array( $template_path ) ) {
@@ -447,7 +447,7 @@ 
 	 * Levels start from 1 (top level post)
 	 *
 	 * @param int $level
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 **/
 	public function show_on_level( $level ) {
 		if ( $level < 0 ) {
@@ -464,7 +464,7 @@ 
 	 *
 	 * @param string $taxonomy_slug
 	 * @param string $term_slug
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 **/
 	public function show_on_taxonomy_term( $term_slug, $taxonomy_slug ) {
 		$term = get_term_by( 'slug', $term_slug, $taxonomy_slug );
@@ -481,7 +481,7 @@ 
 	 * Learn more about {@link http://codex.wordpress.org/Post_Formats Post Formats (Codex)}
 	 *
 	 * @param string|array $post_format Name of the format as listed on Codex
-	 * @return object $this
+	 * @return Post_Meta_Container $this
 	 **/
 	public function show_on_post_format( $post_format ) {
 		if ( is_array( $post_format ) ) {
@@ -503,8 +503,8 @@ 
 	/**
 	 * Show the container only on posts from the specified type(s).
 	 *
-	 * @param string|array $post_types
-	 * @return object $this
+	 * @param string $post_types
+	 * @return Post_Meta_Container $this
 	 **/
 	public function show_on_post_type( $post_types ) {
 		$post_types = (array) $post_types;

core/Container/Repository.php

Doc Comments -1 removed lines

@@ -141,7 +141,6 @@
 	/**
 	 * Check if container identificator id is unique
 	 * 
-	 * @param string $title
 	 */
 	protected function is_unique_panel_id( $id ) {
 		return !in_array( $id, $this->registered_panel_ids );

core/Container/User_Meta_Container.php

Doc Comments +4 added lines, -5 removed lines

@@ -45,7 +45,7 @@ 
 	/**
 	 * Checks whether the current request is valid
 	 *
-	 * @return bool
+	 * @return null|boolean
 	 **/
 	public function is_valid_save( $user_id = 0 ) {
 		if ( ! isset( $_REQUEST[ $this->get_nonce_name() ] ) || ! wp_verify_nonce( $_REQUEST[ $this->get_nonce_name() ], $this->get_nonce_name() ) ) {
@@ -63,7 +63,7 @@ 
 	 * Perform checks whether the current save() request is valid
 	 *
 	 * @param int $user_id ID of the user against which save() is ran
-	 * @return bool
+	 * @return null|boolean
 	 **/
 	public function is_valid_save_conditions( $user_id ) {
 		$valid = true;
@@ -198,7 +198,6 @@ 
 	/**
 	 * Validate and parse the show_for logic rules.
 	 *
-	 * @param array $rules
 	 * @return array
 	 */
 	protected function parse_show_for( $show_for ) {
@@ -246,7 +245,7 @@ 
 	 * Show the container only on users who have the $role role.
 	 *
 	 * @param string $role
-	 * @return object $this
+	 * @return User_Meta_Container $this
 	 **/
 	public function show_on_user_role( $role ) {
 		$this->settings['show_on']['role'] = (array) $role;
@@ -258,7 +257,7 @@ 
 	 * Show the container only for users who have either capabilities or roles setup
 	 *
 	 * @param array $show_for
-	 * @return object $this
+	 * @return User_Meta_Container $this
 	 **/
 	public function show_for( $show_for ) {
 		$this->settings['show_for'] = $this->parse_show_for( $show_for );

core/Container/Widget_Container.php

Doc Comments -1 removed lines

@@ -10,7 +10,6 @@
 	/**
 	 * Create a new widget
 	 *
-	 * @param string $id Unique ID of the widget
 	 **/
 	public function __construct( $unique_id, $title, $type ) {
 		$this->id = $unique_id;

core/Datastore/Key_Value_Datastore.php

Doc Comments +1 added lines

@@ -225,6 +225,7 @@
 	/**
 	 * Convert an array of storage key patterns to a parentheses-enclosed sql comparison
 	 *
+	 * @param string $column
 	 * @return string
 	 **/
 	protected function storage_key_patterns_to_sql( $column, $patterns ) {

core/Field/Checkbox_Field.php

Doc Comments +1 added lines, -1 removed lines

@@ -40,7 +40,7 @@
 	/**
 	 * Return a differently formatted value for end-users
 	 *
-	 * @return mixed
+	 * @return boolean
 	 **/
 	public function get_formatted_value() {
 		return ( $this->get_value() === $this->option_value );