Tracking Ticket: Improve method documentation in core widget classes

[DrewAPicture]

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

[DrewAPicture]

In 34560:

Docs: Improve the method docs for the widget(), update(), form(), and __construct() methods in the WP_Widget base class.

See #34013. See #32246.

[DrewAPicture]

In 34610:

Docs: Improve the documentation for the __construct(), widget(), update(), and form() methods in WP_Widget_Tag_Cloud.

Props leemon.
Fixes #34026. See #34013.

[DrewAPicture]

In 34611:

Docs: Improve documentation for the __construct(), widget(), update(), and form() methods in WP_Widget_Search.

Props leemon.
Fixes #34025. See #34013.

[DrewAPicture]

In 34612:

Docs: Improve documentation for the __construct(), widget(), update(), and form() methods in WP_Widget_RSS.

Props leemon.
Fixes #34024. See #34013.

[DrewAPicture]

In 34613:

Docs: Improve documentation for the __construct(), widget(), update(), and form() methods in WP_Widget_Recent_Posts.

Also fixes a typo in the class DocBlock.

Props leemon.
Fixes #34023. See #34013.

[DrewAPicture]

In 34614:

Docs: Improve documentation for the __construct(), recent_comments_style(), widget(), update(), and form() methods in WP_Widget_Recent_Comments.

Also fixes a typo in the class DocBlock.

Props leemon.
Fixes #34022. See #34013.

[DrewAPicture]

In 34615:

Docs: Improve documentation for the __construct(), widget(), update(), and form() methods in WP_Widget_Pages.

Props leemon.
Fixes #34021. See #34013.

[DrewAPicture]

In 34616:

Docs: Improve documentation for the __construct(), widget(), update(), and form() methods in WP_Widget_Meta.

Props leemon.
Fixes #34020. See #34013.

[DrewAPicture]

In 34617:

Docs: Improve documentation for the __construct(), widget(), update(), and form() methods in WP_Widget_Links.

Props leemon.
Fixes #34019. See #34013.

[DrewAPicture]

In 34618:

Docs: Improve documentation for the __construct(), widget(), update(), form(), and _get_current_taxonomy() methods in WP_Widget_Categories.

Props leemon.
Fixes #34018. See #34013.

[DrewAPicture]

In 34619:

Docs: Improve documentation for the __construct(), widget(), update(), and form() methods in WP_Widget_Calendar.

Props leemon.
Fixes #34017. See #34013.

[DrewAPicture]

In 34620:

Docs: Improve documentation for the __construct(), widget(), update(), and form() methods in WP_Widget_Archives.

Props leemon.
Fixes #34016. See #34013.

[DrewAPicture]

In 34621:

Docs: Improve documentation for the __construct(), widget(), update(), and form() methods in WP_Nav_Menu_Widget.

Props leemon.
Fixes #34015. Fixes #34013.