Make WordPress Core

Opened 6 years ago

Closed 6 years ago

#44410 closed defect (bug) (fixed)

Properties in class missing type definition and description in DOC comments

Reported by: subrataemfluence's profile subrataemfluence Owned by: pento's profile pento
Milestone: 5.1 Priority: normal
Severity: normal Version: 5.1
Component: Customize Keywords: has-patch
Focuses: coding-standards Cc:

Description

Doc comment section is missing for declared public properties.

  • File: src/wp-includes/customize/class-wp-customize-header-image-control.php
class WP_Customize_Header_Image_Control extends WP_Customize_Image_Control {
  public $type = 'header';
  public $uploaded_headers;
  public $default_headers;
  ...
}

Can the proposed patch help?

Attachments (4)

44410.diff (699 bytes) - added by subrataemfluence 6 years ago.
44410-2.diff (700 bytes) - added by subrataemfluence 6 years ago.
44410-3.diff (754 bytes) - added by subrataemfluence 6 years ago.
44410-4.diff (754 bytes) - added by subrataemfluence 6 years ago.

Download all attachments as: .zip

Change History (12)

#1 @GaryJ
6 years ago

The middle DocBlock description is missing a full stop.

#2 @subrataemfluence
6 years ago

Thank you @GaryJ for pointing out the mistake :)
Uploaded a fix.

#3 @westonruter
6 years ago

The phpdoc should include the @since tags.

#4 @SergeyBiryukov
6 years ago

  • Milestone changed from Awaiting Review to 5.0

#5 @subrataemfluence
6 years ago

Thank you @westonruter ! I have uploaded the modified patch. Hope this is OK now.

#6 @subrataemfluence
6 years ago

Silly mistake with @since version.

#7 @pento
6 years ago

  • Milestone changed from 5.0 to 5.1

#8 @pento
6 years ago

  • Owner set to pento
  • Resolution set to fixed
  • Status changed from new to closed

In 44600:

Docs: Add docblocks for WP_Customize_Header_Image_Control member variables.

Props subrataemfluence.
Fixes #44410.

Note: See TracTickets for help on using tickets.