WordPress/wp-includes
Drew Jaynes 23707b1ada Convert various uses of `(optional)` in core parameter descriptions to use the style prescribed in the inline documentation standards for PHP.
The style for marking parameters optional in inline PHP docs is: `@param type $var Optional. Description. Accepts. Default.`, where Accepts can be omitted on a case-by-case basis.

Props coffee2code.
Fixes #30591.

Built from https://develop.svn.wordpress.org/trunk@30753


git-svn-id: http://core.svn.wordpress.org/trunk@30743 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-12-06 21:24:45 +00:00
..
ID3 Update getID3 library to 1.9.8. 2014-09-11 19:07:17 +00:00
SimplePie
Text
certificates Update the bundled root CA's used for outgoing HTTPS requests. 2014-11-21 03:03:22 +00:00
css Filter bar: Better field display on smaller screens. 2014-12-04 22:23:25 +00:00
fonts Dashicons: Update to the latest dashicons files. 2014-08-17 15:01:16 +00:00
images TwentyFifteen: 2014-11-25 06:12:22 +00:00
js TinyMCE: manually fire `ExecCommand` when aligning images as we do `preventDefault()` on `BeforeExecCommand` for them. Props avryl, fixes #30565. 2014-12-06 00:33:24 +00:00
pomo Add missing `@param`s to `src/wp-includes/pomo` files. 2014-11-30 21:41:22 +00:00
theme-compat
admin-bar.php Consistently handle an empty site title in Site and My Sites toolbar menus. 2014-11-28 08:13:24 +00:00
atomlib.php
author-template.php Remove redundant and erroneous `@uses` tag from most core inline documentation. 2014-10-30 01:05:24 +00:00
bookmark-template.php Ensure inline code is markdown-escaped as such, and that code snippets in descriptions are properly indented. 2014-11-24 04:42:22 +00:00
bookmark.php Improve various `@param` docs for `src/wp-includes/*`. 2014-12-01 01:34:24 +00:00
cache.php Improve various `@param` docs for `src/wp-includes/*`. 2014-12-01 01:34:24 +00:00
canonical.php Improve various `@param` docs for `src/wp-includes/*`. 2014-12-01 01:34:24 +00:00
capabilities.php Improve various `@param` docs for `src/wp-includes/*`. 2014-12-01 01:34:24 +00:00
category-template.php Improve various `@param` docs for `src/wp-includes/*`. 2014-12-01 01:34:24 +00:00
category.php Add inline `@see` tags to the docs for the `get_categories_taxonomy` hook. 2014-11-17 17:37:23 +00:00
class-IXR.php Add missing documentation for the `xmlrpc_element_limit` hook in wp-includes/class-IXR.php. 2014-12-05 03:28:22 +00:00
class-feed.php
class-http.php Improve various `@param` docs for `src/wp-includes/*`. 2014-12-01 01:34:24 +00:00
class-json.php
class-oembed.php Improve various `@param` docs for `src/wp-includes/*`. 2014-12-01 01:34:24 +00:00
class-phpass.php Prevent high resource usage when hashing large passwords. props mdawaffe, pento 2014-11-20 16:03:24 +00:00
class-phpmailer.php
class-pop3.php
class-simplepie.php Fix some documentation typos in various core files. 2014-08-13 03:56:17 +00:00
class-smtp.php PHPMailer: Merge upstream commit (PR274). 2014-09-29 10:28:17 +00:00
class-snoopy.php
class-wp-admin-bar.php
class-wp-ajax-response.php Fix some words that aren't words. 2014-08-09 19:30:17 +00:00
class-wp-customize-control.php Show title, album, and artist info for audio files displayed in `WP_Customize_Upload_Control()`. 2014-12-04 01:59:22 +00:00
class-wp-customize-manager.php Correctly capitalize JavaScript throughout core docs. 2014-12-02 00:31:22 +00:00
class-wp-customize-panel.php Customizer: Add panel/section type as CSS class to the HTML container. 2014-12-02 22:16:23 +00:00
class-wp-customize-section.php Customizer: Add panel/section type as CSS class to the HTML container. 2014-12-02 22:16:23 +00:00
class-wp-customize-setting.php Improve various `@param` docs for `src/wp-includes/class-wp-customize*.php`. 2014-11-30 23:33:23 +00:00
class-wp-customize-widgets.php Correctly capitalize JavaScript throughout core docs. 2014-12-02 00:31:22 +00:00
class-wp-editor.php TinyMCE: remove `<address>` from the block formats drop-down. Props avryl, mor10. Fixes #30132. 2014-12-03 20:31:24 +00:00
class-wp-embed.php Improve various `@param` docs for `src/wp-includes/*`. 2014-12-01 01:34:24 +00:00
class-wp-error.php Improve various `@param` docs for `src/wp-includes/*`. 2014-12-01 01:34:24 +00:00
class-wp-http-ixr-client.php Improve various `@param` docs for `src/wp-includes/*`. 2014-12-01 01:34:24 +00:00
class-wp-image-editor-gd.php Improve various `@param` docs for `src/wp-includes/*`. 2014-12-01 01:34:24 +00:00
class-wp-image-editor-imagick.php `WP_Image_Editor_GD` and `WP_Image_Editor_Imagick` should specify type in a doc block for the `$image` property, instead of inferring `bool` and `null`. 2014-11-03 02:38:23 +00:00
class-wp-image-editor.php Fix setting default quality in WP_Image_Editor. 2014-10-04 13:12:15 +00:00
class-wp-theme.php Improve various `@param` docs for `src/wp-includes/*`. 2014-12-01 01:34:24 +00:00
class-wp-walker.php Fix some documentation typos in various core files. 2014-08-13 03:56:17 +00:00
class-wp-xmlrpc-server.php Improve various `@param` docs for `src/wp-includes/*`. 2014-12-01 01:34:24 +00:00
class-wp.php Using let's properly in inline comments lets us move on to more pressing matters of inline documentation. 2014-12-02 04:43:22 +00:00
class.wp-dependencies.php Ensure inline code is markdown-escaped as such, and that code snippets in descriptions are properly indented. 2014-11-24 04:58:22 +00:00
class.wp-scripts.php Convert various uses of `(optional)` in core parameter descriptions to use the style prescribed in the inline documentation standards for PHP. 2014-12-06 21:24:45 +00:00
class.wp-styles.php Improve various `@param` docs for `src/wp-includes/*`. 2014-12-01 01:34:24 +00:00
comment-template.php Correctly capitalize JavaScript throughout core docs. 2014-12-02 00:31:22 +00:00
comment.php Improve various `@param` docs for `src/wp-includes/*`. 2014-12-01 01:34:24 +00:00
compat.php Define `JSON_PRETTY_PRINT` so it can be used with `wp_json_encode()` 2014-10-28 21:13:22 +00:00
cron.php Improve various `@param` docs for `src/wp-includes/*`. 2014-12-01 01:34:24 +00:00
date.php Remove `<code>` tags from translatable string in `WP_Date_Query`. 2014-12-06 02:38:22 +00:00
default-constants.php Set Twenty Fifteen as the new default theme. see #29799. 2014-10-14 19:58:19 +00:00
default-filters.php Revert shared taxonomy term splitting for 4.1. 2014-11-27 00:05:22 +00:00
default-widgets.php Cross-reference `WP_Comment_Query::query()` as the location for finding information on default arguments for `WP_Comment_Query`. 2014-11-08 20:35:22 +00:00
deprecated.php Convert various uses of `(optional)` in core parameter descriptions to use the style prescribed in the inline documentation standards for PHP. 2014-12-06 21:24:45 +00:00
feed-atom-comments.php Introduce 'rss_tag_pre' action, which fires between the xml and rss tags in a feed. 2014-07-07 10:18:15 +00:00
feed-atom.php Introduce 'rss_tag_pre' action, which fires between the xml and rss tags in a feed. 2014-07-07 10:18:15 +00:00
feed-rdf.php Introduce 'rss_tag_pre' action, which fires between the xml and rss tags in a feed. 2014-07-07 10:18:15 +00:00
feed-rss.php
feed-rss2-comments.php Introduce 'rss_tag_pre' action, which fires between the xml and rss tags in a feed. 2014-07-07 10:18:15 +00:00
feed-rss2.php Ensure inline code is markdown-escaped as such, HTML tags are removed from summaries, and that code snippets in descriptions are properly indented. 2014-11-24 05:19:23 +00:00
feed.php Improve various `@param` docs for `src/wp-includes/*`. 2014-12-01 01:34:24 +00:00
formatting.php Revert [28719] and no longer math-process multiplication of negative numbers 2014-12-06 21:24:23 +00:00
functions.php Improve various `@param` docs. 2014-11-30 23:24:25 +00:00
functions.wp-scripts.php Improve various `@param` docs. 2014-11-30 23:24:25 +00:00
functions.wp-styles.php Improve various `@param` docs. 2014-11-30 23:24:25 +00:00
general-template.php Improve various `@param` docs. 2014-12-01 02:17:21 +00:00
http.php Improve various `@param` docs. 2014-11-30 23:24:25 +00:00
kses.php Only backtick-escape individual HTML entities in the DocBlock for `wp_kses_normalize_entities()`. 2014-12-03 11:47:23 +00:00
l10n.php Improve various `@param` docs. 2014-11-30 23:24:25 +00:00
link-template.php Convert various uses of `(optional)` in core parameter descriptions to use the style prescribed in the inline documentation standards for PHP. 2014-12-06 21:24:45 +00:00
load.php Remove unbounded check for "install.php" in `wp_not_installed()`. 2014-11-26 20:56:23 +00:00
locale.php In `WP_Locale`, declare `$number_format` as a property. 2014-11-03 03:40:22 +00:00
media-template.php Clarify the text for the 'Edit Selection' link when multiple media items are selected in the media manager. 2014-12-01 04:15:23 +00:00
media.php Improve various `@param` docs. 2014-11-30 23:24:25 +00:00
meta.php Convert various uses of `(optional)` in core parameter descriptions to use the style prescribed in the inline documentation standards for PHP. 2014-12-06 21:24:45 +00:00
ms-blogs.php Docs Formatting: Backtick-escape inline code for all remaining dynamic hook docs in wp-includes/*. 2014-11-30 12:10:23 +00:00
ms-default-constants.php After [29200], switch back to using `static` vars instead of adding 2 `global`s, as per Sergey. 2014-07-19 23:14:15 +00:00
ms-default-filters.php Simplify the code for calling refresh_blog_details() whenever 'blogname', 'siteurl', or 'post_count' option is updated. 2014-09-02 07:30:16 +00:00
ms-deprecated.php Delete admin_created_user_subject() rather than deprecate 2014-11-02 02:07:23 +00:00
ms-files.php
ms-functions.php Adjust [29806] and revert [29807] to restore placeholder and email copy order. 2014-12-05 01:15:26 +00:00
ms-load.php Ensure inline code is markdown-escaped as such, HTML tags are removed from summaries, and that code snippets in descriptions are properly indented. 2014-11-24 05:53:22 +00:00
ms-settings.php Move ms-load.php and ms-default-constants.php inclusion back to ms-settings.php to avoid breaking WP-CLI. 2014-06-30 23:50:15 +00:00
nav-menu-template.php 4.1 Docs Audit: Spell out HTML element names in DocBlock summaries for the `nav_menu_css_class`, `nav_menu_item_id`, and `nav_menu_link_attributes` filters. 2014-11-28 12:12:23 +00:00
nav-menu.php 4.1 Docs Audit: Formatting, line-wrap, and other fixes for the `wp_get_nav_menus()` DocBlock. 2014-11-28 12:15:23 +00:00
option.php Improve various `@param` docs. 2014-11-30 22:56:25 +00:00
pluggable-deprecated.php Improve the `@param` docs for `src/wp-includes/pluggable*`. 2014-11-30 22:19:25 +00:00
pluggable.php Allow brackets in a URL when it's sanitised for a redirect. Brackets are valid in query parameters. 2014-12-01 03:21:22 +00:00
plugin.php Ensure inline code is markdown-escaped as such, HTML tags are removed from summaries, and that code snippets in descriptions are properly indented. 2014-11-24 06:05:23 +00:00
post-formats.php Remove redundant and erroneous `@uses` tag from most core inline documentation. 2014-10-30 01:05:24 +00:00
post-template.php Correctly capitalize JavaScript throughout core docs. 2014-12-02 00:31:22 +00:00
post-thumbnail-template.php
post.php Give up on making uninterrupted hierarchies work in `get_page_children()` for now, reverts [30159], [30246], [30636]. 2014-12-04 00:24:22 +00:00
query.php Improve various `@param` docs. 2014-12-01 02:17:21 +00:00
registration-functions.php
registration.php
revision.php Improve various `@param` docs. 2014-11-30 22:56:25 +00:00
rewrite.php Using let's properly in inline comments lets us move on to more pressing matters of inline documentation. 2014-12-02 04:43:22 +00:00
rss-functions.php
rss.php Fill in the `@param` types for the args for functions missing them in `wp-admin/includes/deprecated.php` (pour one out). 2014-11-03 06:08:22 +00:00
script-loader.php Update the Iris color picker to version 1.0.7. 2014-11-30 11:44:22 +00:00
session.php Introduce a button on the user profile screen which clears all other sessions, and on the user editing screen which clears all sessions. Only appears when there are applicable sessions which can be cleared. 2014-11-13 15:21:21 +00:00
shortcodes.php Ensure inline code is markdown-escaped as such, HTML tags are removed from summaries, and that code snippets in descriptions are properly indented. 2014-11-24 06:15:24 +00:00
taxonomy.php Fix a typo in [30546]. 2014-12-03 13:55:24 +00:00
template-loader.php
template.php Docs Formatting: Backtick-escape inline code for all remaining dynamic hook docs in wp-includes/*. 2014-11-30 12:10:23 +00:00
theme.php Improve the `@param` docs for `src/includes/theme.php` and `src/includes/update.php`. 2014-11-30 22:44:22 +00:00
update.php Ensure the theme and plugin update checks are always in sync with the current theme and plugin versions before fetching cached update data. This change only triggers a request to the update API when necessary. 2014-12-02 01:52:23 +00:00
user.php Convert various uses of `(optional)` in core parameter descriptions to use the style prescribed in the inline documentation standards for PHP. 2014-12-06 21:24:45 +00:00
vars.php
version.php Convert various uses of `(optional)` in core parameter descriptions to use the style prescribed in the inline documentation standards for PHP. 2014-12-06 21:24:45 +00:00
widgets.php Document the default arguments for `register_sidebar()` in the hash notation style. 2014-12-05 03:38:22 +00:00
wlwmanifest.xml
wp-db.php Convert various uses of `(optional)` in core parameter descriptions to use the style prescribed in the inline documentation standards for PHP. 2014-12-06 21:24:45 +00:00
wp-diff.php Minor syntactical adjustments to the inline documentation for the `revision_text_diff_options` hook. 2014-11-21 03:50:24 +00:00