Twenty Eleven: updated DocBlock comments following Twenty Ten's example; See #17198

git-svn-id: http://svn.automattic.com/wordpress/trunk@17787 1a063a9b-81f0-0310-95a4-ce76da25c4cd

wp-content/themes/twentyeleven/404.php

@@ -1,7 +1,10 @@
 <?php
 /**
+ * The template for displaying 404 pages (Not Found).
+ *
  * @package WordPress
  * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 
 get_header(); ?>

wp-content/themes/twentyeleven/archive.php

@@ -1,7 +1,15 @@
 <?php
 /**
+ * The template for displaying Archive pages.
+ *
+ * Used to display archive-type pages if nothing more specific matches a query.
+ * For example, puts together date-based pages if no date.php file exists.
+ *
+ * Learn more: http://codex.wordpress.org/Template_Hierarchy
+ *
  * @package WordPress
  * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 
 get_header(); ?>

wp-content/themes/twentyeleven/author.php

@@ -1,7 +1,10 @@
 <?php
 /**
+ * The template for displaying Author Archive pages.
+ *
  * @package WordPress
  * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 
 get_header(); ?>

wp-content/themes/twentyeleven/category.php

@@ -1,7 +1,10 @@
 <?php
 /**
+ * The template for displaying Category Archive pages.
+ *
  * @package WordPress
  * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 
 get_header(); ?>

wp-content/themes/twentyeleven/comments.php

@@ -1,7 +1,15 @@
 <?php
 /**
+ * The template for displaying Comments.
+ *
+ * The area of the page that contains both current comments
+ * and the comment form.  The actual display of comments is
+ * handled by a callback to twentyeleven_comment which is
+ * located in the functions.php file.
+ *
  * @package WordPress
  * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 ?>
 	<div id="comments">

wp-content/themes/twentyeleven/content-aside.php

@@ -1,7 +1,12 @@
 <?php
 /**
+ * The template for displaying posts in the Aside Post Format on index and archive pages
+ *
+ * Learn more: http://codex.wordpress.org/Post_Formats
+ * 
  * @package WordPress
  * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 ?>
 

wp-content/themes/twentyeleven/content-featured.php

@@ -1,7 +1,10 @@
 <?php
 /**
+ * The template for displaying content featured in the showcase.php page template
+ *
  * @package WordPress
  * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 
 global $feature_class;

wp-content/themes/twentyeleven/content-gallery.php

@@ -1,7 +1,12 @@
 <?php
 /**
+ * The template for displaying posts in the Gallery Post Format on index and archive pages
+ *
+ * Learn more: http://codex.wordpress.org/Post_Formats
+ * 
  * @package WordPress
  * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 ?>
 

wp-content/themes/twentyeleven/content-image.php

@@ -1,7 +1,12 @@
 <?php
 /**
+ * The template for displaying posts in the Image Post Format on index and archive pages
+ *
+ * Learn more: http://codex.wordpress.org/Post_Formats
+ * 
  * @package WordPress
  * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 ?>
 

wp-content/themes/twentyeleven/content-intro.php

@@ -1,7 +1,10 @@
 <?php
 /**
+ * The template for displaying page content in the showcase.php page template
+ * 
  * @package WordPress
  * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 ?>
 

wp-content/themes/twentyeleven/content-link.php

@@ -1,7 +1,12 @@
 <?php
 /**
+ * The template for displaying posts in the Link Post Format on index and archive pages
+ *
+ * Learn more: http://codex.wordpress.org/Post_Formats
+ * 
  * @package WordPress
  * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 ?>
 

wp-content/themes/twentyeleven/content-page.php

@@ -1,7 +1,10 @@
 <?php
 /**
+ * The template used for displaying page content in page.php
+ *
  * @package WordPress
  * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 ?>
 

wp-content/themes/twentyeleven/content-single.php

@@ -1,7 +1,10 @@
 <?php
 /**
+ * The template for displaying content in the single.php template
+ *
  * @package WordPress
  * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 ?>
 

wp-content/themes/twentyeleven/content.php

@@ -1,7 +1,10 @@
 <?php
 /**
+ * The default template for displaying content
+ *
  * @package WordPress
  * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 ?>
 

wp-content/themes/twentyeleven/footer.php

@@ -1,7 +1,12 @@
 <?php
 /**
+ * The template for displaying the footer.
+ *
+ * Contains the closing of the id=main div and all content after
+ *
  * @package WordPress
  * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 ?>
 

wp-content/themes/twentyeleven/header.php

@@ -1,7 +1,12 @@
 <?php
 /**
+ * The Header for our theme.
+ *
+ * Displays all of the <head> section and everything up till <div id="main">
+ *
  * @package WordPress
  * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 ?><!DOCTYPE html>
 <!--[if IE 6]>

wp-content/themes/twentyeleven/image.php

@@ -1,7 +1,10 @@
 <?php
 /**
+ * The template for displaying image attachments.
+ *
  * @package WordPress
  * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 
 get_header(); ?>

wp-content/themes/twentyeleven/inc/widgets.php

@@ -1,8 +1,12 @@
 <?php
 /**
- * new WordPress Widget format
- * Wordpress 2.8 and above
- * @see http://codex.wordpress.org/Widgets_API#Developing_Widgets
+ * Makes a custom Widget for displaying Aside, Link, Status, and Quote Posts available with Twenty Eleven
+ *
+ * Learn more: http://codex.wordpress.org/Widgets_API#Developing_Widgets
+ *
+ * @package WordPress
+ * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 class Twenty_Eleven_Ephemera_Widget extends WP_Widget {
 

wp-content/themes/twentyeleven/index.php

@@ -1,5 +1,13 @@
 <?php
 /**
+ * The main template file.
+ *
+ * This is the most generic template file in a WordPress theme
+ * and one of the two required files for a theme (the other being style.css).
+ * It is used to display a page when nothing more specific matches a query.
+ * E.g., it puts together the home page when no home.php file exists.
+ * Learn more: http://codex.wordpress.org/Template_Hierarchy
+ *
  * @package WordPress
  * @subpackage Twenty Eleven
  */

wp-content/themes/twentyeleven/page.php

@@ -1,7 +1,15 @@
 <?php
 /**
+ * The template for displaying all pages.
+ *
+ * This is the template that displays all pages by default.
+ * Please note that this is the WordPress construct of pages
+ * and that other 'pages' on your WordPress site will use a
+ * different template.
+ *
  * @package WordPress
  * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 
 get_header(); ?>

wp-content/themes/twentyeleven/search.php

@@ -1,7 +1,10 @@
 <?php
 /**
+ * The template for displaying Search Results pages.
+ *
  * @package WordPress
  * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 
 get_header(); ?>

wp-content/themes/twentyeleven/searchform.php

@@ -1,7 +1,10 @@
 <?php
 /**
+ * The template for displaying search forms in Twenty Eleven
+ *
  * @package WordPress
  * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 ?>
 	<form method="get" id="searchform" action="<?php echo home_url( '/' ); ?>">

wp-content/themes/twentyeleven/showcase.php

@@ -11,6 +11,7 @@
  *
  * @package WordPress
  * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 
 // Enqueue showcase script for the slider

wp-content/themes/twentyeleven/sidebar.php

@@ -1,7 +1,10 @@
 <?php
 /**
+ * The Sidebar containing the main widget area.
+ *
  * @package WordPress
  * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 ?>
 		<div id="secondary" class="widget-area" role="complementary">

wp-content/themes/twentyeleven/single.php

@@ -1,7 +1,10 @@
 <?php
 /**
+ * The Template for displaying all single posts.
+ *
  * @package WordPress
  * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 
 get_header(); ?>

wp-content/themes/twentyeleven/tag.php

@@ -4,6 +4,7 @@
  *
  * @package WordPress
  * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 
 get_header(); ?>