Opened 12 years ago
Closed 12 years ago
#28298 closed task (blessed) (fixed)
Improve inline docs for functional default arguments throughout core
| Reported by: | DrewAPicture | Owned by: | |
|---|---|---|---|
| Priority: | normal | Milestone: | 4.1 |
| Component: | General | Version: | |
| Severity: | normal | Keywords: | |
| Cc: | Focuses: | docs |
Description
This ticket will serve as a tracking ticket for documenting functional args arrays throughout core.
Attachments (3)
Change History (21)
This ticket was mentioned in IRC in #wordpress-dev by DrewAPicture. View the logs.
12 years ago
@
12 years ago
Convert documentation for default arguments in register_sidebar() to a hash notation.
@
12 years ago
Add documentation for default arguments in the_widget(). (Plus minor formatting tweaks to the function's other @params.)
#12
@
12 years ago
Handled the remaining hash notation-related fixes for src/wp-includes/widgets.php:
- 28298.register_sidebar.diff converts
register_sidebar()default argument docs to hash notation - 28298.register_sidebars.diff adds default argument docs for
register_sidebars() - 28298.the_widget.diff adds default argument docs for
the_widget(). Also minor formatting tweaks to the existing @param docs (to include: adding “Optional.”, adding ending periods, capitalizing descriptions, aligning descriptions, removing “@return void”)
Note:
See TracTickets
for help on using tickets.
![(please configure the [header_logo] section in trac.ini)](/chrome/site/your_project_logo.png)
In 28474: