WordPress/wp-includes
Drew Jaynes 8eb2d3610b Inline documentation cleanup in wp-includes/comment-template.php.
This cleanup follows [25567] and brings the docs in-line with standards that at the time had not yet been finalized.

These changes include
* Moving in-line `@see` tags to their own lines
* Using docs-specific variables in hook docs
* Fixing line-wrapping throughout
* Typos and punctuation
* Converting hash notation values to variables per the standard

Fixes #27083. See #20495.

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


git-svn-id: http://core.svn.wordpress.org/trunk@27022 1a063a9b-81f0-0310-95a4-ce76da25c4cd
2014-02-10 03:20:12 +00:00
..
ID3 ID3 1.9.7. 2013-07-13 00:37:36 +00:00
SimplePie SimplePie: Fix use of DOMElement as array. 2013-09-11 04:02:10 +00:00
Text Declare Text_Diff::trimNewlines() as static. Upstream is not back compat. props aaroncampbell. fixes #24372. 2013-05-25 22:10:53 +00:00
certificates Move a certificate higher in the file (end to start) so that PHP 5.2.x (OpenSSL 0.9.8j and earlier) can parse the file correctly. See #25007 2013-09-23 13:59:11 +00:00
css Merge colors.css into wp-admin.css. Non-default color schemes became overloads rather than swaps in the 3.8 redesign. Benefits include: 2014-02-06 06:25:18 +00:00
fonts Update Dashicons to latest. Adds line break, paragraph, code, and bbPress. 2014-01-31 00:41:13 +00:00
images Remove many of the now-unused images in core. Some images have been left for now, notably our previous style icons, action indicators, and images that see a higher frequency of use in plugins to allow them more time to adapt to the new design. props ocean90, Ipstenu, coffee2code. fixes #26036. 2013-12-09 03:21:12 +00:00
js Various JSHint fixes. see #26446. 2014-02-08 00:52:12 +00:00
pomo Fix strict notices in Tests_POMO_PO. 2013-12-01 12:48:10 +00:00
theme-compat Use site_url() in theme-compat. 2013-10-02 21:17:09 +00:00
admin-bar.php Improve keyboard accessibility for the admin menu when in responsive mode, props SergeyBiryukov, fixes #26639 for trunk. 2014-01-22 20:08:11 +00:00
atomlib.php First there were two, and now there are three -- in the @since versions that came before and that shall be. And so it will be, says nacin. 2013-12-24 18:57:12 +00:00
author-template.php First there were two, and now there are three -- in the @since versions that came before and that shall be. And so it will be, says nacin. 2013-12-24 18:57:12 +00:00
bookmark-template.php Use a docs-specific variable for the `link_category` hook docs in wp-admin/bookmarks-template.php. 2014-01-18 16:58:13 +00:00
bookmark.php Add some missing braces to get_bookmarks() which was causing an early return. Introduced in [25934]. See #25468. Fixes #25874 2013-11-08 02:20:10 +00:00
cache.php Remove `$force` argument from `WP_Object_Cache::delete()`. From @nacin: "This was for internal-use-only, I don't think _deprecated_argument() is needed, but let's put a comment somewhere just so we know we'd have to be careful if we ever want to add a third argument here later." 2014-02-01 22:25:16 +00:00
canonical.php First there were two, and now there are three -- in the @since versions that came before and that shall be. And so it will be, says nacin. 2013-12-24 18:57:12 +00:00
capabilities.php Inline documentation for hooks in wp-includes/capabilities.php. 2013-11-13 04:39:08 +00:00
category-template.php Add arguments to the wp_dropdown_cats filter, and docs. 2014-02-02 05:33:13 +00:00
category.php Revert r25824:25875 from the core.svn.wordpress.org repository. 2013-10-25 02:29:52 +00:00
class-IXR.php First there were two, and now there are three -- in the @since versions that came before and that shall be. And so it will be, says nacin. 2013-12-24 18:57:12 +00:00
class-feed.php Inline documentation for hooks in wp-includes/class-feed.php. 2013-10-08 20:07:08 +00:00
class-http.php Inline documentation for hooks in wp-includes/class-http.php. 2014-01-28 08:25:11 +00:00
class-json.php Patch Services_JSON to use the proper function name and avoid a fatal error. see #24210. 2013-07-08 16:55:34 +00:00
class-oembed.php Add meetup.com oEmbed support. see #23171. 2014-02-08 01:14:11 +00:00
class-phpass.php First there were two, and now there are three -- in the @since versions that came before and that shall be. And so it will be, says nacin. 2013-12-24 18:57:12 +00:00
class-phpmailer.php Backport a fix for qmail from PHPMailer upstream. 2013-10-03 03:00:09 +00:00
class-pop3.php Update pop3 class. Props aaroncampbell. fixes #17064 2011-04-21 20:40:32 +00:00
class-simplepie.php Update SimplePie to 1.3.1. Props rmccue, ocean90. fixes #22321 2012-11-05 14:25:25 +00:00
class-smtp.php Update to PHPMailer 5.2.4. props bpetty. fixes #21074. 2013-02-28 18:33:13 +00:00
class-snoopy.php Use correct variable in the deprecated and abandoned Snoopy HTTP client. see #24210. 2013-07-08 17:17:46 +00:00
class-wp-admin-bar.php Bring in the responsive component of MP6. See #25858. 2013-11-13 18:00:10 +00:00
class-wp-ajax-response.php Specify the charset in WP_Ajax_Response::send(). Props sergey.s.betke@novgaro.ru, SergeyBiryukov. fixes #19448 2012-08-15 18:17:21 +00:00
class-wp-customize-control.php Remove /extend/ from URLs to wordpress.org/plugins, /themes, and /mobile, as those are all now top-level. see #24389. 2013-05-22 21:01:57 +00:00
class-wp-customize-manager.php Avoid empty header color after enabling header text via Customizer. props obenland, fixes #23761. 2013-07-12 20:41:46 +00:00
class-wp-customize-section.php Inline documentation for hooks in wp-includes/class-wp-customize-section.php. 2014-01-02 02:07:11 +00:00
class-wp-customize-setting.php Use wp_unslash() instead of stripslashes() and stripslashes_deep(). Use wp_slash() instead of add_magic_quotes(). 2013-03-03 16:30:38 +00:00
class-wp-editor.php When using wp_editor(), make it easier to specify which editor is shown first, fixes #20822 2014-02-05 00:34:12 +00:00
class-wp-embed.php Inline documentation for core shortcode attributes. 2014-01-07 16:07:12 +00:00
class-wp-error.php Correct inline docs for is_wp_error(). props johnbillion. fixes #24637. 2013-06-24 18:23:45 +00:00
class-wp-http-ixr-client.php Lose EOF ?>. Clean up EOF newlines. fixes #12307 2012-01-08 17:01:11 +00:00
class-wp-image-editor-gd.php The Pinking Shears stir from their slumber, awakened by what may seem, to those 2013-12-11 19:49:11 +00:00
class-wp-image-editor-imagick.php The Pinking Shears stir from their slumber, awakened by what may seem, to those 2013-12-11 19:49:11 +00:00
class-wp-image-editor.php Two more hook docs fixes. 2013-12-04 23:51:19 +00:00
class-wp-theme.php Inline documentation for hooks in wp-includes/class-wp-theme.php. 2014-01-02 01:54:10 +00:00
class-wp-walker.php Revert r25824:25875 from the core.svn.wordpress.org repository. 2013-10-25 02:29:52 +00:00
class-wp-xmlrpc-server.php First there were two, and now there are three -- in the @since versions that came before and that shall be. And so it will be, says nacin. 2013-12-24 18:57:12 +00:00
class-wp.php Remove the experimental RSS.JS feed, and move it to a plugin for feature development. Unprops pento. See #25639 2013-12-04 22:24:10 +00:00
class.wp-dependencies.php Inline documentation for WP_Dependencies and _WP_Dependency classes. 2013-09-20 19:54:10 +00:00
class.wp-scripts.php If the script_loader_src filter returns nothing, bail instead of printing <script src="">. 2013-09-16 22:12:09 +00:00
class.wp-styles.php Fix the conditional enqueueing/printing of colors stylesheets, without breaking dependencies. 2014-02-06 22:16:11 +00:00
comment-template.php Inline documentation cleanup in wp-includes/comment-template.php. 2014-02-10 03:20:12 +00:00
comment.php Use a float for last_changed microtime cache values. 2014-02-07 08:14:12 +00:00
compat.php Restore compat for json_decode and json_encode. fixes #18015 for trunk. 2011-07-06 23:33:05 +00:00
cron.php Cron: Fix a case where a cache inconsistency can cause wp_clear_scheduled_hook() to enter an infinite loop. This unravels the function from using other cron api functions to looping over the cron array directly. See #25773 2013-12-07 09:13:11 +00:00
date.php Add description for 'dayofyear' and 'dayofweek' arguments in WP_Date_Query. 2013-11-16 08:21:10 +00:00
default-constants.php First there were two, and now there are three -- in the @since versions that came before and that shall be. And so it will be, says nacin. 2013-12-24 18:57:12 +00:00
default-filters.php Remove unused arg from wp_auth_check(), see #27081. 2014-02-09 22:34:11 +00:00
default-widgets.php Widgets: improve the help text on the Widgets screen, props siobhan, props Hanni, fixes #26244. 2013-12-01 18:29:09 +00:00
deprecated.php Deprecate rich_edit_exists(). It doesn't make sense to support deleting the TinyMCE directory when we have auto-updates. Fixes #26786. 2014-01-13 00:00:12 +00:00
feed-atom-comments.php Inline documentation for hooks in wp-includes/feed-atom-comments.php. 2013-12-21 20:22:12 +00:00
feed-atom.php Inline documentation for hooks in wp-includes/feed-atom.php. 2013-09-20 22:50:10 +00:00
feed-rdf.php Revert r25824:25875 from the core.svn.wordpress.org repository. 2013-10-25 02:29:52 +00:00
feed-rss.php Revert r25824:25875 from the core.svn.wordpress.org repository. 2013-10-25 02:29:52 +00:00
feed-rss2-comments.php Revert r25824:25875 from the core.svn.wordpress.org repository. 2013-10-25 02:29:52 +00:00
feed-rss2.php Inline documentation for hooks in wp-includes/feed-rss2.php. 2013-09-20 22:27:09 +00:00
feed.php Correct @since values. see #26253. 2014-01-04 18:09:12 +00:00
formatting.php When a video shortcode has content in its body, append it as inner HTML in the resulting `<video>`. 2014-02-05 01:43:12 +00:00
functions.php Remove unused arg from wp_auth_check(), see #27081. 2014-02-09 22:34:11 +00:00
functions.wp-scripts.php Inline documentation for hooks in wp-includes/functions.wp-scripts.php. 2013-10-27 17:51:09 +00:00
functions.wp-styles.php Inline documentation for hooks in wp-includes/functions.wp-styles.php. 2013-10-27 17:59:09 +00:00
general-template.php Improve inline documenation for `get_the_time()` and `get_post_time(). 2014-02-09 21:03:13 +00:00
http.php Use get_current_site() instead of the $current_site global when possible. 2013-11-13 03:23:10 +00:00
kses.php Add dfn, mark, and samp to kses. 2014-01-17 08:38:09 +00:00
l10n.php Add jshintrc to qunit. 2013-10-30 14:39:10 +00:00
link-template.php Docs fix: edit_comment_link() doesn't actually return anything. 2014-01-24 07:17:36 +00:00
load.php Inline documentation for hooks in wp-includes/load.php. 2013-09-16 18:30:10 +00:00
locale.php Better description for WP_Locale::_strings_for_pot(). props dimadin. fixes #25937. 2013-11-13 14:01:09 +00:00
media-template.php Remove a stray </div> from the Edit Image template, was breaking it in IE < 9. Props gcorne, see #24409 2014-02-09 18:45:11 +00:00
media.php has_image_size()'s parameter should be required. see [27139], see #26951. 2014-02-08 23:53:12 +00:00
meta.php In `update_meta_cache()`, ensure that meta is always stored in the same order. Removes an unnecessary `$wpdb->prepare` statement. Adds unit test. 2013-11-21 19:31:10 +00:00
ms-blogs.php Inline documentation for hooks in wp-includes/ms-blogs.php. 2013-12-01 17:32:10 +00:00
ms-default-constants.php Use get_current_site() instead of the $current_site global when possible. 2013-11-13 03:23:10 +00:00
ms-default-filters.php Live network counts of users and sites for small networks. 2013-09-25 16:21:09 +00:00
ms-deprecated.php Introduce wp_get_sites(), a long-awaited replacement for get_blog_list(). 2013-09-14 21:13:10 +00:00
ms-files.php Use stripslashes() instead of wp_unslash() in ms-files.php to avoid formatting.php dependency. props devesine, fixes #24374. 2013-05-20 20:20:22 +00:00
ms-functions.php Collect the post and link ids that will be reassigned before running the update in `remove_user_from_blog()`. Use `array_walk()` instead of `array_map()` when invalidating the caches for the collected ids. 2014-02-09 21:47:12 +00:00
ms-load.php Remove an unnecessary variable passed to wpdb::prepare() during multisite load. 2014-02-02 22:09:12 +00:00
ms-settings.php Resurrect the switched global. Some are still using it. see #21459 2012-08-22 03:34:00 +00:00
nav-menu-template.php First there were two, and now there are three -- in the @since versions that came before and that shall be. And so it will be, says nacin. 2013-12-24 18:57:12 +00:00
nav-menu.php Nav Menu: Remove post/page items from the Nav Menu when the post/page is deleted. 2014-02-09 21:37:11 +00:00
option.php Prefix the `notoptions` cache key in the multisite `site-options` group with `$wpdb->siteid` to avoid collisions and race conditions when using a fancy multi-network setup. Adds unit test. 2013-11-21 19:07:10 +00:00
pluggable-deprecated.php First there were two, and now there are three -- in the @since versions that came before and that shall be. And so it will be, says nacin. 2013-12-24 18:57:12 +00:00
pluggable.php Improve inline documentation for `wp_new_user_notification()`. 2014-02-09 21:07:12 +00:00
plugin.php First there were two, and now there are three -- in the @since versions that came before and that shall be. And so it will be, says nacin. 2013-12-24 18:57:12 +00:00
post-formats.php Allow has_post_format() to be used to check for any format. 2013-11-24 13:45:10 +00:00
post-template.php Fix validation issue in get_the_password_form() caused by wpautop(). 2014-02-08 13:23:13 +00:00
post-thumbnail-template.php First there were two, and now there are three -- in the @since versions that came before and that shall be. And so it will be, says nacin. 2013-12-24 18:57:12 +00:00
post.php Inline documentation for the `wp_insert_attachment_data` filter hook, added in [27130]. 2014-02-08 22:47:12 +00:00
query.php Fix an error in SQL generation when `perm` is set and an array is passed for `post_status`. Adds unit test. 2014-02-02 07:36:13 +00:00
registration-functions.php Lose EOF ?>. Clean up EOF newlines. fixes #12307 2012-01-08 17:01:11 +00:00
registration.php Lose EOF ?>. Clean up EOF newlines. fixes #12307 2012-01-08 17:01:11 +00:00
revision.php `get_comment()`, `wp_get_post_revision()`, and `get_term()` all used to return by reference. Because of this, `$null` was set to `null` so the return value would be a variable where applicable. This has not been necessary since [21792], so the `$null`s have been removed. 2014-01-29 06:46:12 +00:00
rewrite.php Remove the experimental RSS.JS feed, and move it to a plugin for feature development. Unprops pento. See #25639 2013-12-04 22:24:10 +00:00
rss-functions.php Don't rely on include_path to include files. 2013-09-25 00:18:11 +00:00
rss.php Inline docs for hooks in MagPie. 2013-09-06 17:19:09 +00:00
script-loader.php Fix the conditional enqueueing/printing of colors stylesheets, without breaking dependencies. 2014-02-06 22:16:11 +00:00
shortcodes.php First there were two, and now there are three -- in the @since versions that came before and that shall be. And so it will be, says nacin. 2013-12-24 18:57:12 +00:00
taxonomy.php Reuse the `terms` cache group for taxonomy cache invalidation. 2014-02-09 17:42:11 +00:00
template-loader.php Add jshintrc to qunit. 2013-10-30 14:39:10 +00:00
template.php Inline documentation improvements for get_*_template() functions in wp-includes/template.php. 2014-01-05 17:55:11 +00:00
theme.php First there were two, and now there are three -- in the @since versions that came before and that shall be. And so it will be, says nacin. 2013-12-24 18:57:12 +00:00
update.php Updates: Force an update check to occur when the 'Check Again' button is used in the Dashboard. Fixes #25831 2013-11-15 03:04:10 +00:00
user.php Correct 'found_users_query' filter description. see #25533. 2014-01-04 18:50:11 +00:00
vars.php Update the wp-inclues/vars.php file header to include Nginx as a recognized web server. 2014-01-10 18:15:13 +00:00
version.php Fix the conditional enqueueing/printing of colors stylesheets, without breaking dependencies. 2014-02-06 22:16:11 +00:00
widgets.php First there were two, and now there are three -- in the @since versions that came before and that shall be. And so it will be, says nacin. 2013-12-24 18:57:12 +00:00
wlwmanifest.xml The Pinking Shears stir from their slumber, awakened by what may seem, to those 2013-12-11 19:49:11 +00:00
wp-db.php Fixes for hooks documentation in wp-includes/wp-db.php. 2014-02-09 20:51:13 +00:00
wp-diff.php Remove old debug comment. props nofearinc. fixes #25865. 2013-11-08 22:24:09 +00:00