htmlburger / carbon-fields

core/Carbon_Fields.php

Doc Comments +1 added lines, -3 removed lines

@@ -51,7 +51,7 @@ 
 	/**
 	 * Singleton implementation
 	 *
-	 * @return Carbon_Fields\Carbon_Fields
+	 * @return Carbon_Fields|null
 	 */
 	public static function instance() {
 		static $instance = null;
@@ -134,7 +134,6 @@ 
 	/**
 	 * Extend Carbon Fields by adding a new entity (container condition etc.)
 	 *
-	 * @param string $type     Type of extension - 'container_condition'
 	 * @param string $class    Extension class name
 	 * @param string $extender Extending callable
 	 */
@@ -231,7 +230,6 @@ 
 	/**
 	 * Remove a listener from any event
 	 * 
-	 * @param Listener $removed_listener
 	 */
 	public static function remove_listener( $listener ) {
 		static::instance()->get_emitter()->remove_listener( $listener );

core/Container/Container.php

Doc Comments +5 added lines, -4 removed lines

@@ -383,6 +383,7 @@ 
 	/**
 	 * Check if all conditions pass for object
 	 *
+	 * @param integer $object_id
 	 * @return bool
 	 */
 	protected function all_conditions_pass( $object_id ) {
@@ -543,7 +544,7 @@ 
 	 * Set datastore instance
 	 *
 	 * @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() ) {
@@ -711,7 +712,7 @@ 
 	 * Set CSS classes that the container should use.
 	 *
 	 * @param string|array<string> $classes
-	 * @return object $this
+	 * @return Container $this
 	 */
 	public function set_classes( $classes ) {
 		$this->classes = Helper::sanitize_classes( $classes );
@@ -770,7 +771,7 @@ 
 	 * assigned to them instead.
 	 *
 	 * @param array $fields
-	 * @return object $this
+	 * @return Container $this
 	 */
 	public function add_fields( $fields ) {
 		foreach ( $fields as $field ) {
@@ -800,7 +801,7 @@ 
 	 *
 	 * @param string $tab_name
 	 * @param array $fields
-	 * @return object $this
+	 * @return Container $this
 	 */
 	public function add_tab( $tab_name, $fields ) {
 		$this->add_fields( $fields );

core/Field/Field.php

Doc Comments +11 added lines, -11 removed lines

@@ -203,7 +203,6 @@ 
 	/**
 	 * Create a new field of type $type and name $name and label $label.
 	 *
-	 * @param string $type
 	 * @param string $name lower case and underscore-delimited
 	 * @param string $label (optional) Automatically generated from $name if not present
 	 * @return Field
@@ -465,7 +464,7 @@ 
 	 * Set datastore instance
 	 *
 	 * @param Datastore_Interface $datastore
-	 * @return object $this
+	 * @return Field $this
 	 */
 	public function set_datastore( Datastore_Interface $datastore, $set_as_default = false ) {
 		if ( $set_as_default && ! $this->has_default_datastore() ) {
@@ -489,7 +488,7 @@ 
 	 * Assign the type of the container this field is in
 	 *
 	 * @param string
-	 * @return object $this
+	 * @return Field $this
 	 */
 	public function set_context( $context ) {
 		$this->context = $context;
@@ -594,6 +593,7 @@ 
 
 	/**
 	 * Set field base name as defined in the container.
+	 * @param string $name
 	 */
 	public function set_base_name( $name ) {
 		$this->base_name = $name;
@@ -690,7 +690,7 @@ 
 	/**
 	 * Return the field help text
 	 *
-	 * @return object $this
+	 * @return string $this
 	 */
 	public function get_help_text() {
 		return $this->help_text;
@@ -700,7 +700,7 @@ 
 	 * Set additional text to be displayed during field render,
 	 * containing information and guidance for the user
 	 *
-	 * @return object $this
+	 * @return Field $this
 	 */
 	public function set_help_text( $help_text ) {
 		$this->help_text = $help_text;
@@ -711,7 +711,7 @@ 
 	 * Alias for set_help_text()
 	 *
 	 * @see set_help_text()
-	 * @return object $this
+	 * @return Field $this
 	 */
 	public function help_text( $help_text ) {
 		return $this->set_help_text( $help_text );
@@ -730,7 +730,7 @@ 
 	 * Whether or not this value should be auto loaded. Applicable to theme options only.
 	 *
 	 * @param bool $autoload
-	 * @return object $this
+	 * @return Field $this
 	 */
 	public function set_autoload( $autoload ) {
 		$this->autoload = $autoload;
@@ -750,7 +750,7 @@ 
 	 * Whether or not this field will be initialized when the field is in the viewport (visible).
 	 *
 	 * @param bool $lazyload
-	 * @return object $this
+	 * @return Field $this
 	 */
 	public function set_lazyload( $lazyload ) {
 		$this->lazyload = $lazyload;
@@ -770,7 +770,7 @@ 
 	 * Set the field width.
 	 *
 	 * @param int $width
-	 * @return object $this
+	 * @return Field $this
 	 */
 	public function set_width( $width ) {
 		$this->width = (int) $width;
@@ -790,7 +790,7 @@ 
 	 * Set CSS classes that the container should use.
 	 *
 	 * @param string|array<string> $classes
-	 * @return object $this
+	 * @return Field $this
 	 */
 	public function set_classes( $classes ) {
 		$this->classes = Helper::sanitize_classes( $classes );
@@ -801,7 +801,7 @@ 
 	 * Whether this field is mandatory for the user
 	 *
 	 * @param bool $required
-	 * @return object $this
+	 * @return Field $this
 	 */
 	public function set_required( $required = true ) {
 		$this->required = $required;

core/Provider/Container_Condition_Provider.php

Doc Comments +6 added lines, -6 removed lines

@@ -241,7 +241,7 @@ 
 	 *
 	 * @param  array<string>                     $condition_types
 	 * @param  Carbon_Fields\Container\Container $container
-	 * @return array<string>
+	 * @return string[]
 	 */
 	public function filter_post_meta_container_static_condition_types( $condition_types, $container_type, $container ) {
 		return array_merge(
@@ -255,7 +255,7 @@ 
 	 *
 	 * @param  array<string>                     $condition_types
 	 * @param  Carbon_Fields\Container\Container $container
-	 * @return array<string>
+	 * @return string[]
 	 */
 	public function filter_post_meta_container_dynamic_condition_types( $condition_types, $container_type, $container ) {
 		return array_merge(
@@ -269,7 +269,7 @@ 
 	 *
 	 * @param  array<string>                     $condition_types
 	 * @param  Carbon_Fields\Container\Container $container
-	 * @return array<string>
+	 * @return string[]
 	 */
 	public function filter_term_meta_container_static_condition_types( $condition_types, $container_type, $container ) {
 		return array_merge(
@@ -283,7 +283,7 @@ 
 	 *
 	 * @param  array<string>                     $condition_types
 	 * @param  Carbon_Fields\Container\Container $container
-	 * @return array<string>
+	 * @return string[]
 	 */
 	public function filter_term_meta_container_dynamic_condition_types( $condition_types, $container_type, $container ) {
 		return array_merge(
@@ -297,7 +297,7 @@ 
 	 *
 	 * @param  array<string>                     $condition_types
 	 * @param  Carbon_Fields\Container\Container $container
-	 * @return array<string>
+	 * @return string[]
 	 */
 	public function filter_user_meta_container_static_condition_types( $condition_types, $container_type, $container ) {
 		return array_merge(
@@ -311,7 +311,7 @@ 
 	 *
 	 * @param  array<string>                     $condition_types
 	 * @param  Carbon_Fields\Container\Container $container
-	 * @return array<string>
+	 * @return string[]
 	 */
 	public function filter_user_meta_container_dynamic_condition_types( $condition_types, $container_type, $container ) {
 		return array_merge(