Docs: Improve docblocks in WP_Comments_List_Table

[huzaifaalmesbah]

Description

Improves inline documentation for WP_Comments_List_Table in wp-admin/includes/class-wp-comments-list-table.php to align with WordPress coding standards.

Changes

• Added missing summary descriptions.
• Improved specificity of @return and @param tags.

Testing Instructions

1. Inspect src/wp-admin/includes/class-wp-comments-list-table.php.
2. Verify docblocks follow standards.

Trac ticket: https://core.trac.wordpress.org/ticket/64224

[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, noruzzaman.

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.

[noruzzamans]

Thanks for the update @huzaifaalmesbah! I have gone through the changes, and everything looks cleaner and much easier to follow now. The added descriptions and improved @return / @param details definitely make the docblocks more useful.
Nice improvement overall.

[huzaifaalmesbah]

@westonruter Thank you for your review and suggestions. I’ve applied the changes you recommended.

[Copilot]

Pull request overview

This pull request improves the inline documentation (docblocks) for the WP_Comments_List_Table class to align with WordPress coding standards. The changes add missing summary descriptions and improve the specificity of @return and @param tags across 17 methods.

Changes:

• Added summary descriptions to methods that previously had only parameter or return documentation
• Enhanced global variable descriptions with more specific context
• Updated return type annotations to be more descriptive

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[westonruter]

Committed in r61521 (a5681c4)