Twenty Eleven: Improve PHP DocBlock compliance with documentation standards

[huzaifaalmesbah]

Updates PHP DocBlocks in Twenty Eleven theme to better align with WordPress PHP Documentation Standards.

Changes include:

• Use third-person singular verbs in function summaries
• Add missing @return tags for better type documentation
• Complete @param documentation for widget methods
• Ensure proper sentence structure with punctuation
• Add missing DocBlock for twentyeleven_theme_options_help()

Files modified:

• inc/theme-options.php: Updated 9 function DocBlocks
• inc/widgets.php: Enhanced widget update() method documentation

Fixes https://core.trac.wordpress.org/ticket/64211

[github-actions]

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props huzaifaalmesbah, westonruter, dhruvang21, juanfra, sabernhardt.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

[github-actions]

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

• The Plugin and Theme Directories cannot be accessed within Playground.
• All changes will be lost when closing a tab with a Playground instance.
• All changes will be lost when refreshing the page.
• A fresh instance is created each time the link below is clicked.
• Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
  it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

[dhruvang21]

LGTM

[juanfra]

LGTM

[sabernhardt]

Thanks for the PR!

Please

1. Change the @since version number for twentyeleven_theme_options_help() (added in r19237).
2. Add a @since note for twentyeleven_option_page_capability(). r17987 created the function, and WordPress 3.2 bundled Twenty Eleven 1.1.
   * @since Twenty Eleven 1.1

My suggestions for Twenty_Eleven_Ephemera_Widget::update() are more questionable.

[huzaifaalmesbah]

Thanks for the detailed review and version history notes @sabernhardt I’ve updated the @SInCE tags accordingly and reviewed your suggestions for Twenty_Eleven_Ephemera_Widget::update(). Really appreciate your guidance!

[sabernhardt]

Thanks!

[github-actions]

A commit was made that fixes the Trac ticket referenced in the description of this pull request.

SVN changeset: 61309
GitHub commit: a107147

This PR will be closed, but please confirm the accuracy of this and reopen if there is more work to be done.