4.1 Docs Audit: Various formatting fixes for inline documentation in class-wp-list-table.php and comment-template.php.

See #30469.

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


git-svn-id: http://core.svn.wordpress.org/trunk@30600 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-11-28 11:22:23 +00:00
parent 21a521db09
commit 4432dc752b
3 changed files with 12 additions and 4 deletions

View File

@ -65,7 +65,7 @@ class WP_List_Table {
private $_pagination; private $_pagination;
/** /**
* The view switcher modes * The view switcher modes.
* *
* @since 4.1.0 * @since 4.1.0
* @var array * @var array

View File

@ -53,6 +53,7 @@ function get_comment_author( $comment_ID = 0 ) {
*/ */
function comment_author( $comment_ID = 0 ) { function comment_author( $comment_ID = 0 ) {
$author = get_comment_author( $comment_ID ); $author = get_comment_author( $comment_ID );
/** /**
* Filter the comment author's name for display. * Filter the comment author's name for display.
* *
@ -76,6 +77,7 @@ function comment_author( $comment_ID = 0 ) {
*/ */
function get_comment_author_email( $comment_ID = 0 ) { function get_comment_author_email( $comment_ID = 0 ) {
$comment = get_comment( $comment_ID ); $comment = get_comment( $comment_ID );
/** /**
* Filter the comment author's returned email address. * Filter the comment author's returned email address.
* *
@ -104,6 +106,7 @@ function get_comment_author_email( $comment_ID = 0 ) {
*/ */
function comment_author_email( $comment_ID = 0 ) { function comment_author_email( $comment_ID = 0 ) {
$author_email = get_comment_author_email( $comment_ID ); $author_email = get_comment_author_email( $comment_ID );
/** /**
* Filter the comment author's email for display. * Filter the comment author's email for display.
* *
@ -157,11 +160,12 @@ function comment_author_email_link( $linktext = '', $before = '', $after = '' )
*/ */
function get_comment_author_email_link( $linktext = '', $before = '', $after = '' ) { function get_comment_author_email_link( $linktext = '', $before = '', $after = '' ) {
global $comment; global $comment;
/** /**
* Filter the comment author's email for display. * Filter the comment author's email for display.
* *
* Care should be taken to protect the email address and assure that email * Care should be taken to protect the email address and assure that email
* harvesters do not capture your commenters' email address. * harvesters do not capture your commenter's email address.
* *
* @since 1.2.0 * @since 1.2.0
* @since 4.1.0 The `$comment` parameter was added. * @since 4.1.0 The `$comment` parameter was added.
@ -280,6 +284,7 @@ function get_comment_author_url( $comment_ID = 0 ) {
$comment = get_comment( $comment_ID ); $comment = get_comment( $comment_ID );
$url = ('http://' == $comment->comment_author_url) ? '' : $comment->comment_author_url; $url = ('http://' == $comment->comment_author_url) ? '' : $comment->comment_author_url;
$url = esc_url( $url, array('http', 'https') ); $url = esc_url( $url, array('http', 'https') );
/** /**
* Filter the comment author's URL. * Filter the comment author's URL.
* *
@ -303,6 +308,7 @@ function get_comment_author_url( $comment_ID = 0 ) {
*/ */
function comment_author_url( $comment_ID = 0 ) { function comment_author_url( $comment_ID = 0 ) {
$author_url = get_comment_author_url( $comment_ID ); $author_url = get_comment_author_url( $comment_ID );
/** /**
* Filter the comment author's URL for display. * Filter the comment author's URL for display.
* *
@ -571,6 +577,7 @@ function get_comment_excerpt( $comment_ID = 0 ) {
*/ */
function comment_excerpt( $comment_ID = 0 ) { function comment_excerpt( $comment_ID = 0 ) {
$comment_excerpt = get_comment_excerpt($comment_ID); $comment_excerpt = get_comment_excerpt($comment_ID);
/** /**
* Filter the comment excerpt for display. * Filter the comment excerpt for display.
* *
@ -592,6 +599,7 @@ function comment_excerpt( $comment_ID = 0 ) {
*/ */
function get_comment_ID() { function get_comment_ID() {
global $comment; global $comment;
/** /**
* Filter the returned comment ID. * Filter the returned comment ID.
* *
@ -1386,7 +1394,7 @@ function get_comment_reply_link( $args = array(), $comment = null, $post = null
* @param array $args Comment reply link arguments. See {@see get_comment_reply_link()} * @param array $args Comment reply link arguments. See {@see get_comment_reply_link()}
* for more information on accepted arguments. * for more information on accepted arguments.
* @param object $comment The object of the comment being replied to. * @param object $comment The object of the comment being replied to.
* @param WP_Post $post The WP_Post object. * @param WP_Post $post The {@see WP_Post} object.
*/ */
$args = apply_filters( 'comment_reply_link_args', $args, $comment, $post ); $args = apply_filters( 'comment_reply_link_args', $args, $comment, $post );

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.1-beta2-30609'; $wp_version = '4.1-beta2-30610';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.