WordPress.org

Make WordPress Core

Opened 6 years ago

Closed 6 years ago

Last modified 6 years ago

#36300 closed defect (bug) (fixed)

Docs for Walker classes

Reported by: ramiy Owned by: DrewAPicture
Milestone: 4.5 Priority: normal
Severity: normal Version:
Component: General Keywords: has-patch
Focuses: docs Cc:

Description

See the attached patch.

Attachments (1)

walker-docs.patch (7.1 KB) - added by ramiy 6 years ago.

Download all attachments as: .zip

Change History (19)

@ramiy
6 years ago

#1 follow-up: @DrewAPicture
6 years ago

  • Keywords has-patch added

On Walker_CategoryDropdown, I'll make these changes on commit, but note that tag order is important. @since is pretty much always first except in specific cases such as @internal tags, some @link tags and @static tags. Also, the only elements in a file that get @package and @subpackage tags are the file headers themselves.

#2 @DrewAPicture
6 years ago

In 37045:

Docs: Improve inline documentation in property and method DocBlocks for Walker_CategoryDropdown.

Props ramiy for the initial patch.
See #36300.

#3 @DrewAPicture
6 years ago

In 37046:

Docs: Improve inline documentation for property and methods in Walker_Category.

Props raimy for the initial patch.
See #36300.

#4 @DrewAPicture
6 years ago

In 37047:

Docs: Mark optional parameters in Walker_Category methods as such.

Also cleans up some syntax.

See #36300.

#5 @DrewAPicture
6 years ago

In 37048:

Docs: Improve inline documentation for properties and methods in Walker_Comment.

Props raimy for the initial patch.
See #36300.

#6 @DrewAPicture
6 years ago

In 37049:

Docs: Standardize the class DocBlock summary for Walker_Comment.

See #36300.

#7 @DrewAPicture
6 years ago

In 37050:

Docs: Improve inline documentation syntax for Walker_Comment.

  • Marks optional parameters as such
  • Improves existing parameter descriptions for clarity
  • Syntax improvements

See #36300.

#8 @DrewAPicture
6 years ago

In 37051:

Docs: Comment display element object types for Walker_Comment are WP_Comment since 4.4.0.

See #36300.

#9 @DrewAPicture
6 years ago

In 37052:

Docs: Normalize Walker_Comment method parameter docs spacing following [37051].

See #36300.

#10 @DrewAPicture
6 years ago

In 37053:

Docs: Improve inline documentation for properties and methods in Walker_PageDropdown.

Props raimy for the initial patch.
See #36300.

#11 @DrewAPicture
6 years ago

In 37054:

Docs: The page object type in use in Walker_PageDropdown is WP_Post.

See #36300.

#12 @DrewAPicture
6 years ago

In 37055:

Docs: Improve inline documentation for properties and methods in Walker_Page.

Props raimy.
See #36300.

#13 @DrewAPicture
6 years ago

In 37056:

Docs: The page object type in use in Walker_Page is WP_Post.

See #36300.

#14 @DrewAPicture
6 years ago

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

In 37057:

Docs: Mark optional method parameters as such in Walker_Page.

Also normalizes parameter spacing following [37056].

Fixes #36300.

#15 @DrewAPicture
6 years ago

  • Milestone changed from Awaiting Review to 4.5

#16 in reply to: ↑ 1 @ramiy
6 years ago

Replying to DrewAPicture:

On Walker_CategoryDropdown, I'll make these changes on commit, but note that tag order is important. @since is pretty much always first except in specific cases such as @internal tags, some @link tags and @static tags. Also, the only elements in a file that get @package and @subpackage tags are the file headers themselves.

Ok, thanks for the feedback. I will remember for me next patches.

#17 follow-up: @ramiy
6 years ago

@DrewAPicture you spelled my name wrong - "Props ramiy" not "Props raimy"

#18 in reply to: ↑ 17 @DrewAPicture
6 years ago

Replying to ramiy:

@DrewAPicture you spelled my name wrong - "Props ramiy" not "Props raimy"

Sorry, won't happen again.

Note: See TracTickets for help on using tickets.