From ca9d1fc6932cedbcd300c5d30522f97170afdc6f Mon Sep 17 00:00:00 2001
From: Drew Jaynes <drewapicture@git.wordpress.org>
Date: Fri, 20 Sep 2013 22:49:36 +0000
Subject: [PATCH] Inline documentation for hooks in wp-includes/feed-atom.php.

Props dustyf.
See #25229.


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

diff --git a/src/wp-includes/feed-atom.php b/src/wp-includes/feed-atom.php
index 983c8f4a3d..666b52df99 100644
--- a/src/wp-includes/feed-atom.php
+++ b/src/wp-includes/feed-atom.php
@@ -14,7 +14,14 @@ echo '<?xml version="1.0" encoding="'.get_option('blog_charset').'"?'.'>'; ?>
   xmlns:thr="http://purl.org/syndication/thread/1.0"
   xml:lang="<?php bloginfo_rss( 'language' ); ?>"
   xml:base="<?php bloginfo_rss('url') ?>/wp-atom.php"
-  <?php do_action('atom_ns'); ?>
+  <?php
+  /**
+   * Fires at end of the Atom feed root to add namespaces.
+   *
+   * @since 2.0.0
+   */
+  do_action( 'atom_ns' );
+  ?>
  >
 	<title type="text"><?php bloginfo_rss('name'); wp_title_rss(); ?></title>
 	<subtitle type="text"><?php bloginfo_rss("description") ?></subtitle>
@@ -25,15 +32,30 @@ echo '<?xml version="1.0" encoding="'.get_option('blog_charset').'"?'.'>'; ?>
 	<id><?php bloginfo('atom_url'); ?></id>
 	<link rel="self" type="application/atom+xml" href="<?php self_link(); ?>" />
 
-	<?php do_action('atom_head'); ?>
-	<?php while (have_posts()) : the_post(); ?>
+	<?php
+	/**
+	 * Fires just before the first Atom feed entry.
+	 *
+	 * @since 2.0.0
+	 */
+	do_action( 'atom_head' );
+
+	while ( have_posts() ) : the_post();
+	?>
 	<entry>
 		<author>
 			<name><?php the_author() ?></name>
 			<?php $author_url = get_the_author_meta('url'); if ( !empty($author_url) ) : ?>
 			<uri><?php the_author_meta('url')?></uri>
 			<?php endif;
-			do_action('atom_author'); ?>
+
+			/**
+			 * Fires at the end of each Atom feed author entry.
+			 *
+			 * @since 3.2.0
+			 */
+			do_action( 'atom_author' );
+		?>
 		</author>
 		<title type="<?php html_type_rss(); ?>"><![CDATA[<?php the_title_rss() ?>]]></title>
 		<link rel="alternate" type="<?php bloginfo_rss('html_type'); ?>" href="<?php the_permalink_rss() ?>" />
@@ -45,8 +67,14 @@ echo '<?xml version="1.0" encoding="'.get_option('blog_charset').'"?'.'>'; ?>
 <?php if ( !get_option('rss_use_excerpt') ) : ?>
 		<content type="<?php html_type_rss(); ?>" xml:base="<?php the_permalink_rss() ?>"><![CDATA[<?php the_content_feed('atom') ?>]]></content>
 <?php endif; ?>
-<?php atom_enclosure(); ?>
-<?php do_action('atom_entry'); ?>
+	<?php atom_enclosure();
+	/**
+	 * Fires at the end of each Atom feed item.
+	 *
+	 * @since 2.0.0
+	 */
+	do_action( 'atom_entry' );
+		?>
 		<link rel="replies" type="<?php bloginfo_rss('html_type'); ?>" href="<?php the_permalink_rss() ?>#comments" thr:count="<?php echo get_comments_number()?>"/>
 		<link rel="replies" type="application/atom+xml" href="<?php echo esc_url( get_post_comments_feed_link(0, 'atom') ); ?>" thr:count="<?php echo get_comments_number()?>"/>
 		<thr:total><?php echo get_comments_number()?></thr:total>