[wp-trac] [WordPress Trac] #34013: Tracking Ticket: Improve method documentation in core widget classes

[WordPress Trac]

#34013: Tracking Ticket: Improve method documentation in core widget classes
----------------------------+-------------------
 Reporter:  DrewAPicture    |       Owner:
     Type:  task (blessed)  |      Status:  new
 Priority:  normal          |   Milestone:  4.4
Component:  Widgets         |     Version:
 Severity:  normal          |  Resolution:
 Keywords:  good-first-bug  |     Focuses:  docs
----------------------------+-------------------
Changes (by DrewAPicture):

 * keywords:   => good-first-bug


Old description:

> The core widget classes have gone long enough not having complete method
> documentation. What makes this especially late-in-coming is the fact that
> the `form()`, `widget()`, and `update()` methods in `WP_Widget` base
> class ''already have'' docs, most of the time we just need to copy them
> to the sub-classes and make some minor adjustments to tailor to the
> specific widget type.
>
> And now that all of the core widget classes are in their own fancy new
> files as of [33843], there's no better time than now to spruce them up.
> In #33701 I already fixed the file headers and class DocBlocks, now we
> just need the method docs.
>
> Let's do it.
>
> Core widget classes:
>
> * `WP_Nav_Menu_Widget` => class-wp-nav-menu-widget.php
> * `WP_Widget_Archives` => class-wp-widget-archives.php
> * `WP_Widget_Calendar` => class-wp-widget-calendar.php
> * `WP_Widget_Categories` => class-wp-widget-categories.php
> * `WP_Widget_Links` => class-wp-widget-links.php
> * `WP_Widget_Meta` => class-wp-widget-meta.php
> * `WP_Widget_Pages` => class-wp-widget-pages.php
> * `WP_Widget_Recent_Comments` => class-wp-widget-recent-comments.php
> * `WP_Widget_Recent_Posts` => class-wp-widget-recent-posts.php
> * `WP_Widget_RSS` => class-wp-widget-rss.php
> * `WP_Widget_Search` => class-wp-widget-search.php
> * `WP_Widget_Tag_Cloud` => class-wp-widget-tag-cloud.php
> * `WP_Widget_Text` => class-wp-widget-text.php

New description:

 The core widget classes have gone long enough not having complete method
 documentation. What makes this especially late-in-coming is the fact that
 the `form()`, `widget()`, and `update()` methods in `WP_Widget` base class
 ''already have'' docs, most of the time we just need to copy them to the
 sub-classes and make some minor adjustments to tailor to the specific
 widget type.

 And now that all of the core widget classes are in their own fancy new
 files as of [33843], there's no better time than now to spruce them up. In
 #33701 I already fixed the file headers and class DocBlocks, now we just
 need the method docs.

 Let's do it.

 Tickets by file:

 * #34015 – `WP_Nav_Menu_Widget` => class-wp-nav-menu-widget.php
 * #34016 – `WP_Widget_Archives` => class-wp-widget-archives.php
 * #34017 – `WP_Widget_Calendar` => class-wp-widget-calendar.php
 * #34018 – `WP_Widget_Categories` => class-wp-widget-categories.php
 * #34019 – `WP_Widget_Links` => class-wp-widget-links.php
 * #34020 – `WP_Widget_Meta` => class-wp-widget-meta.php
 * #34021 – `WP_Widget_Pages` => class-wp-widget-pages.php
 * #34022 – `WP_Widget_Recent_Comments` => class-wp-widget-recent-
 comments.php
 * #34023 – `WP_Widget_Recent_Posts` => class-wp-widget-recent-posts.php
 * #34024 – `WP_Widget_RSS` => class-wp-widget-rss.php
 * #34025 – `WP_Widget_Search` => class-wp-widget-search.php
 * #34026 – `WP_Widget_Tag_Cloud` => class-wp-widget-tag-cloud.php
 * #34027 – `WP_Widget_Text` => class-wp-widget-text.php

--

--
Ticket URL: <https://core.trac.wordpress.org/ticket/34013#comment:1>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform