From 9af6ba32365fb7e976637758f3fb7d55a7a9137c Mon Sep 17 00:00:00 2001
From: Ian Stewart <iandstewart@git.wordpress.org>
Date: Mon, 2 May 2011 21:04:44 +0000
Subject: [PATCH] Twenty Eleven: updated DocBlock comments following Twenty
 Ten's example; See #17198

git-svn-id: https://develop.svn.wordpress.org/trunk@17787 602fd350-edb4-49c9-b593-d223f7449a82
---
 wp-content/themes/twentyeleven/404.php              |  3 +++
 wp-content/themes/twentyeleven/archive.php          |  8 ++++++++
 wp-content/themes/twentyeleven/author.php           |  3 +++
 wp-content/themes/twentyeleven/category.php         |  3 +++
 wp-content/themes/twentyeleven/comments.php         |  8 ++++++++
 wp-content/themes/twentyeleven/content-aside.php    |  5 +++++
 wp-content/themes/twentyeleven/content-featured.php |  3 +++
 wp-content/themes/twentyeleven/content-gallery.php  |  5 +++++
 wp-content/themes/twentyeleven/content-image.php    |  5 +++++
 wp-content/themes/twentyeleven/content-intro.php    |  3 +++
 wp-content/themes/twentyeleven/content-link.php     |  5 +++++
 wp-content/themes/twentyeleven/content-page.php     |  3 +++
 wp-content/themes/twentyeleven/content-single.php   |  3 +++
 wp-content/themes/twentyeleven/content.php          |  3 +++
 wp-content/themes/twentyeleven/footer.php           |  5 +++++
 wp-content/themes/twentyeleven/header.php           |  5 +++++
 wp-content/themes/twentyeleven/image.php            |  3 +++
 wp-content/themes/twentyeleven/inc/widgets.php      | 10 +++++++---
 wp-content/themes/twentyeleven/index.php            |  8 ++++++++
 wp-content/themes/twentyeleven/page.php             |  8 ++++++++
 wp-content/themes/twentyeleven/search.php           |  3 +++
 wp-content/themes/twentyeleven/searchform.php       |  3 +++
 wp-content/themes/twentyeleven/showcase.php         |  1 +
 wp-content/themes/twentyeleven/sidebar.php          |  3 +++
 wp-content/themes/twentyeleven/single.php           |  3 +++
 wp-content/themes/twentyeleven/tag.php              |  1 +
 26 files changed, 110 insertions(+), 3 deletions(-)

diff --git a/wp-content/themes/twentyeleven/404.php b/wp-content/themes/twentyeleven/404.php
index 1e5bf40524..d88272ec78 100644
--- a/wp-content/themes/twentyeleven/404.php
+++ b/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(); ?>
diff --git a/wp-content/themes/twentyeleven/archive.php b/wp-content/themes/twentyeleven/archive.php
index 7694dbd5cb..f91671b125 100644
--- a/wp-content/themes/twentyeleven/archive.php
+++ b/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(); ?>
diff --git a/wp-content/themes/twentyeleven/author.php b/wp-content/themes/twentyeleven/author.php
index 4b3203a888..38782c5a94 100644
--- a/wp-content/themes/twentyeleven/author.php
+++ b/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(); ?>
diff --git a/wp-content/themes/twentyeleven/category.php b/wp-content/themes/twentyeleven/category.php
index 37b8476fcd..4cacc939f3 100644
--- a/wp-content/themes/twentyeleven/category.php
+++ b/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(); ?>
diff --git a/wp-content/themes/twentyeleven/comments.php b/wp-content/themes/twentyeleven/comments.php
index 1dc09f1a26..78c853d47b 100644
--- a/wp-content/themes/twentyeleven/comments.php
+++ b/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">
diff --git a/wp-content/themes/twentyeleven/content-aside.php b/wp-content/themes/twentyeleven/content-aside.php
index d66b73c01f..a7330558c7 100644
--- a/wp-content/themes/twentyeleven/content-aside.php
+++ b/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
  */
 ?>
 
diff --git a/wp-content/themes/twentyeleven/content-featured.php b/wp-content/themes/twentyeleven/content-featured.php
index 2b71ba046d..fb3d67831f 100644
--- a/wp-content/themes/twentyeleven/content-featured.php
+++ b/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;
diff --git a/wp-content/themes/twentyeleven/content-gallery.php b/wp-content/themes/twentyeleven/content-gallery.php
index 9906da72db..491a30dfe6 100644
--- a/wp-content/themes/twentyeleven/content-gallery.php
+++ b/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
  */
 ?>
 
diff --git a/wp-content/themes/twentyeleven/content-image.php b/wp-content/themes/twentyeleven/content-image.php
index 0ab376f5c9..7ca4bd2be0 100644
--- a/wp-content/themes/twentyeleven/content-image.php
+++ b/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
  */
 ?>
 
diff --git a/wp-content/themes/twentyeleven/content-intro.php b/wp-content/themes/twentyeleven/content-intro.php
index 020d4d3269..b63d1ffd8a 100644
--- a/wp-content/themes/twentyeleven/content-intro.php
+++ b/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
  */
 ?>
 
diff --git a/wp-content/themes/twentyeleven/content-link.php b/wp-content/themes/twentyeleven/content-link.php
index 9eda54181f..e665f67bc6 100644
--- a/wp-content/themes/twentyeleven/content-link.php
+++ b/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
  */
 ?>
 
diff --git a/wp-content/themes/twentyeleven/content-page.php b/wp-content/themes/twentyeleven/content-page.php
index 15404db9cd..f921247c40 100644
--- a/wp-content/themes/twentyeleven/content-page.php
+++ b/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
  */
 ?>
 
diff --git a/wp-content/themes/twentyeleven/content-single.php b/wp-content/themes/twentyeleven/content-single.php
index 7a9154c841..7ee52f3078 100644
--- a/wp-content/themes/twentyeleven/content-single.php
+++ b/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
  */
 ?>
 
diff --git a/wp-content/themes/twentyeleven/content.php b/wp-content/themes/twentyeleven/content.php
index 11c6ebee1d..efa0fe0955 100644
--- a/wp-content/themes/twentyeleven/content.php
+++ b/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
  */
 ?>
 
diff --git a/wp-content/themes/twentyeleven/footer.php b/wp-content/themes/twentyeleven/footer.php
index 5bc983a1ba..eca118b62a 100644
--- a/wp-content/themes/twentyeleven/footer.php
+++ b/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
  */
 ?>
 
diff --git a/wp-content/themes/twentyeleven/header.php b/wp-content/themes/twentyeleven/header.php
index 041e5d5c2c..fb11b89a37 100644
--- a/wp-content/themes/twentyeleven/header.php
+++ b/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]>
diff --git a/wp-content/themes/twentyeleven/image.php b/wp-content/themes/twentyeleven/image.php
index d136f9c07e..a80eee74a5 100644
--- a/wp-content/themes/twentyeleven/image.php
+++ b/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(); ?>
diff --git a/wp-content/themes/twentyeleven/inc/widgets.php b/wp-content/themes/twentyeleven/inc/widgets.php
index 08e4ed9c94..56622936c7 100644
--- a/wp-content/themes/twentyeleven/inc/widgets.php
+++ b/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 {
 
diff --git a/wp-content/themes/twentyeleven/index.php b/wp-content/themes/twentyeleven/index.php
index a84ca54da3..2195c41e9d 100644
--- a/wp-content/themes/twentyeleven/index.php
+++ b/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
  */
diff --git a/wp-content/themes/twentyeleven/page.php b/wp-content/themes/twentyeleven/page.php
index 26a2ee97fa..f7ed6187b1 100644
--- a/wp-content/themes/twentyeleven/page.php
+++ b/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(); ?>
diff --git a/wp-content/themes/twentyeleven/search.php b/wp-content/themes/twentyeleven/search.php
index 04e39aa0f4..f92124cc93 100644
--- a/wp-content/themes/twentyeleven/search.php
+++ b/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(); ?>
diff --git a/wp-content/themes/twentyeleven/searchform.php b/wp-content/themes/twentyeleven/searchform.php
index ae77bc2097..ce4176326b 100644
--- a/wp-content/themes/twentyeleven/searchform.php
+++ b/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( '/' ); ?>">
diff --git a/wp-content/themes/twentyeleven/showcase.php b/wp-content/themes/twentyeleven/showcase.php
index 4fa4a4a150..14e70a3f7d 100644
--- a/wp-content/themes/twentyeleven/showcase.php
+++ b/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
diff --git a/wp-content/themes/twentyeleven/sidebar.php b/wp-content/themes/twentyeleven/sidebar.php
index 3356a53cb5..5403ada1e2 100644
--- a/wp-content/themes/twentyeleven/sidebar.php
+++ b/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">
diff --git a/wp-content/themes/twentyeleven/single.php b/wp-content/themes/twentyeleven/single.php
index ce2272f2a0..d77361677b 100644
--- a/wp-content/themes/twentyeleven/single.php
+++ b/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(); ?>
diff --git a/wp-content/themes/twentyeleven/tag.php b/wp-content/themes/twentyeleven/tag.php
index 2fd243469a..749e87e8a4 100644
--- a/wp-content/themes/twentyeleven/tag.php
+++ b/wp-content/themes/twentyeleven/tag.php
@@ -4,6 +4,7 @@
  *
  * @package WordPress
  * @subpackage Twenty Eleven
+ * @since Twenty Eleven 1.0
  */
 
 get_header(); ?>