From 9321ee7f29c4b059ee65cd3256d71d39cc501198 Mon Sep 17 00:00:00 2001
From: Drew Jaynes <drewapicture@git.wordpress.org>
Date: Sat, 21 Dec 2013 20:21:20 +0000
Subject: [PATCH] Inline documentation for hooks in
 wp-includes/feed-atom-comments.php.

Props dustyf, piontkowski, kpdesign.
Fixes #26532.


git-svn-id: https://develop.svn.wordpress.org/trunk@26863 602fd350-edb4-49c9-b593-d223f7449a82
---
 src/wp-includes/feed-atom-comments.php | 31 +++++++++++++++++++++++---
 1 file changed, 28 insertions(+), 3 deletions(-)

diff --git a/src/wp-includes/feed-atom-comments.php b/src/wp-includes/feed-atom-comments.php
index a7777f198a..13a55a206a 100644
--- a/src/wp-includes/feed-atom-comments.php
+++ b/src/wp-includes/feed-atom-comments.php
@@ -12,7 +12,17 @@ echo '<?xml version="1.0" encoding="' . get_option('blog_charset') . '" ?' . '>'
 	xmlns="http://www.w3.org/2005/Atom"
 	xml:lang="<?php bloginfo_rss( 'language' ); ?>"
 	xmlns:thr="http://purl.org/syndication/thread/1.0"
-	<?php do_action('atom_ns'); do_action('atom_comments_ns'); ?>
+	<?php 
+		/** This action is documented in wp-includes/feed-atom.php */
+		do_action( 'atom_ns' ); 
+		
+		/**
+		 * Fires inside the feed tag in the Atom comment feed.
+		 *
+		 * @since 2.8.0
+		 */
+		do_action( 'atom_comments_ns' );
+	?>
 >
 	<title type="text"><?php
 		if ( is_singular() )
@@ -39,7 +49,14 @@ echo '<?xml version="1.0" encoding="' . get_option('blog_charset') . '" ?' . '>'
 	<link rel="self" type="application/atom+xml" href="<?php bloginfo_rss('comments_atom_url'); ?>" />
 	<id><?php bloginfo_rss('comments_atom_url'); ?></id>
 <?php } ?>
-<?php do_action('comments_atom_head'); ?>
+<?php 
+	/**
+	 * Fires at the end of the Atom comment feed header.
+	 *
+	 * @since 2.8.0
+	 */
+	do_action( 'comments_atom_head' );
+?>
 <?php
 if ( have_comments() ) : while ( have_comments() ) : the_comment();
 	$comment_post = $GLOBALS['post'] = get_post( $comment->comment_post_ID );
@@ -80,7 +97,15 @@ if ( have_comments() ) : while ( have_comments() ) : the_comment();
 ?>
 		<thr:in-reply-to ref="<?php comment_guid($parent_comment) ?>" href="<?php echo get_comment_link($parent_comment) ?>" type="<?php bloginfo_rss('html_type'); ?>" />
 <?php endif;
-	do_action('comment_atom_entry', $comment->comment_ID, $comment_post->ID);
+	/**
+	 * Fires at the end of each Atom comment feed item.
+	 *
+	 * @since 2.2.0
+	 *
+	 * @param int $comment_id      ID of the current comment.
+	 * @param int $comment_post_id ID of the post the current comment is connected to.
+	 */
+	do_action( 'comment_atom_entry', $comment->comment_ID, $comment_post->ID );
 ?>
 	</entry>
 <?php endwhile; endif; ?>