Ticket #12695: twentytendoc.4.demetris.diff

Index: wp-content/themes/twentyten/404.php
===================================================================
--- wp-content/themes/twentyten/404.php (revision 13845)
+++ wp-content/themes/twentyten/404.php (working copy)
@@ -1,3 +1,13 @@
+<?php
+/**
+ * The template for displaying 404 pages (Not Found)
+ *
+ * @since 0.7.0
+ * @package WordPress
+ * @subpackage 2010
+ */
+?>
+
 <?php get_header(); ?>
 
        <div id="container">
Index: wp-content/themes/twentyten/archive.php
===================================================================
--- wp-content/themes/twentyten/archive.php     (revision 13845)
+++ wp-content/themes/twentyten/archive.php     (working copy)
@@ -1,3 +1,17 @@
+<?php
+/**
+ * Generic template for Archive pages
+ *
+ * Used to display archive-type pages if nothing more specific matches a query.
+ * E.g., puts together date-based pages if no date.php file exists.
+ * Learn more: http://codex.wordpress.org/Template_Hierarchy
+ *
+ * @since 0.7.0
+ * @package WordPress
+ * @subpackage 2010
+ */
+?>
+
 <?php get_header(); ?>
 
                <div id="container">
Index: wp-content/themes/twentyten/attachment.php
===================================================================
--- wp-content/themes/twentyten/attachment.php  (revision 13845)
+++ wp-content/themes/twentyten/attachment.php  (working copy)
@@ -1,3 +1,13 @@
+<?php
+/**
+ * The template used to display Attachment-type pages
+ *
+ * @since 0.7.0
+ * @package WordPress
+ * @subpackage 2010
+ */
+?>
+
 <?php get_header(); ?>
 
                <div id="container">
Index: wp-content/themes/twentyten/author.php
===================================================================
--- wp-content/themes/twentyten/author.php      (revision 13845)
+++ wp-content/themes/twentyten/author.php      (working copy)
@@ -1,3 +1,13 @@
+<?php
+/**
+ * The template used to display Author Archive pages
+ *
+ * @since 0.7.0
+ * @package WordPress
+ * @subpackage 2010
+ */
+?>
+
 <?php get_header(); ?>
 
                <div id="container">
Index: wp-content/themes/twentyten/category.php
===================================================================
--- wp-content/themes/twentyten/category.php    (revision 13845)
+++ wp-content/themes/twentyten/category.php    (working copy)
@@ -1,3 +1,13 @@
+<?php
+/**
+ * The template used to display Category Archive pages
+ *
+ * @since 0.7.0
+ * @package WordPress
+ * @subpackage 2010
+ */
+?>
+
 <?php get_header(); ?>
 
                <div id="container">
@@ -13,7 +23,7 @@
                                 * If you want to overload this in a child theme then include a file
                                 * called loop-category.php and that will be used instead.
                                 */
-                                get_template_part( 'loop', 'category' );
+                               get_template_part( 'loop', 'category' );
                                ?>
 
                        </div><!-- #content -->
Index: wp-content/themes/twentyten/comments.php
===================================================================
--- wp-content/themes/twentyten/comments.php    (revision 13845)
+++ wp-content/themes/twentyten/comments.php    (working copy)
@@ -1,3 +1,18 @@
+<?php
+/**
+ * The template used to display 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 twentyten_comment which is
+ * located in the functions.php file
+ *
+ * @since 0.7.0
+ * @package WordPress
+ * @subpackage 2010
+ */
+?>
+
                        <div id="comments">
 <?php if ( post_password_required() ) : ?>
                                <div class="nopassword"><?php _e( 'This post is password protected. Enter the password to view any comments.', 'twentyten' ); ?></div>
Index: wp-content/themes/twentyten/footer.php
===================================================================
--- wp-content/themes/twentyten/footer.php      (revision 13845)
+++ wp-content/themes/twentyten/footer.php      (working copy)
@@ -1,3 +1,16 @@
+<?php
+/**
+ * The template used to display the footer
+ *
+ * Contains the closing of the id=main div and all content
+ * after.  Calls sidebar-footer.php for bottom widgets
+ *
+ * @since 0.7.0
+ * @package WordPress
+ * @subpackage 2010
+ */
+?>
+
        </div><!-- #main -->
 
        <div id="footer">
Index: wp-content/themes/twentyten/functions.php
===================================================================
--- wp-content/themes/twentyten/functions.php   (revision 13845)
+++ wp-content/themes/twentyten/functions.php   (working copy)
@@ -1,9 +1,36 @@
 <?php
+/**
+ * TwentyTen functions and definitions
+ *
+ * Sets up the theme and provides some helper functions used
+ * in other parts of the theme.  All functions are pluggable
+ *
+ * @since 0.7.0
+ * @package WordPress
+ * @subpackage 2010
+ */
 
-// Set the content width based on the Theme CSS
+// Set the content width based on the Theme CSS.  Can be overriden
 if ( ! isset( $content_width ) )
        $content_width = 640;
 
+
+/**
+ * Set up defaults for our theme.
+ *
+ * Sets up theme defaults and tells wordpress that this is a
+ * theme that will take advantage of Post Thumbnails, Custom
+ * Background, Nav Menus and automatic feed links.  To
+ * override any of the settings in a child theme, create your
+ * own twentyten_init function
+ *
+ * @uses add_theme_support()
+ *
+ * @since 0.7.0
+ *
+ *
+ */
+
 if ( ! function_exists( 'twentyten_init' ) ) :
 function twentyten_init() {
        // Your Changeable header business starts here
@@ -90,6 +117,12 @@
 endif;
 add_action( 'after_setup_theme', 'twentyten_init' );
 
+/**
+ * Callback to style the header image inside the admin
+ *
+ *
+ */
+
 if ( ! function_exists( 'twentyten_admin_header_style' ) ) :
 function twentyten_admin_header_style() {
 ?>
@@ -106,7 +139,18 @@
 }
 endif;
 
-// Get the page number
+
+/**
+ * Returns the page number currently being browsed
+ *
+ * Returns a vertical bar followed by page and the page
+ * number.  Is pluggable
+ *
+ * @since 0.7.0
+ * @retun string
+ */
+
+
 if ( ! function_exists( 'twentyten_get_page_number' ) ) :
 function twentyten_get_page_number() {
        if ( get_query_var( 'paged' ) )
@@ -114,14 +158,27 @@
 }
 endif;
 
-// Echo the page number
+/**
+ * Echos the page number being browsed
+ *
+ * @since 0.7.0
+ * @uses twentyten_get_page_number
+ *
+ */
+
 if ( ! function_exists( 'twentyten_the_page_number' ) ) :
 function twentyten_the_page_number() {
        echo twentyten_get_page_number();
 }
 endif;
 
-// Control excerpt length
+/**
+ * Sets the excerpt length to 40 charachters.  Is pluggable
+ *
+ * @since 0.7.0
+ * @return int
+ */
+
 if ( ! function_exists( 'twentyten_excerpt_length' ) ) :
 function twentyten_excerpt_length( $length ) {
        return 40;
@@ -130,7 +187,13 @@
 add_filter( 'excerpt_length', 'twentyten_excerpt_length' );
 
 
-// Make a nice read more link on excerpts
+/**
+ * Sets the read more link for excerpts to something pretty
+ *
+ * @since 0.7.0
+ * @return string
+ *
+ */
 if ( ! function_exists( 'twentyten_excerpt_more' ) ) :
 function twentyten_excerpt_more( $more ) {
        return '&nbsp;&hellip; <a href="'. get_permalink() . '">' . __('Continue&nbsp;reading&nbsp;<span class="meta-nav">&rarr;</span>', 'twentyten') . '</a>';
@@ -139,7 +202,14 @@
 add_filter( 'excerpt_more', 'twentyten_excerpt_more' );
 
 
-// Template for comments and pingbacks
+/**
+ * Template for comments and pingbacks
+ *
+ * Used as a callback by wp_list_comments for displaying the
+ * comments.  Is pluggable
+ *
+ * @since 0.7.0
+ */
 if ( ! function_exists( 'twentyten_comment' ) ) :
 function twentyten_comment( $comment, $args, $depth ) {
        $GLOBALS ['comment'] = $comment; ?>
@@ -171,7 +241,12 @@
 }
 endif;
 
-// Remove inline styles on gallery shortcode
+/**
+ * Remove inline styles on gallery shortcode
+ *
+ * @since 0.7.0
+ * @return string
+ */
 if ( ! function_exists( 'twentyten_remove_gallery_css' ) ) :
 function twentyten_remove_gallery_css( $css ) {
        return preg_replace( "#<style type='text/css'>(.*?)</style>#s", '', $css );
@@ -179,18 +254,52 @@
 endif;
 add_filter( 'gallery_style', 'twentyten_remove_gallery_css' );
 
+/**
+ * Returns the list of categories
+ *
+ * Returns the list of categories based on if we are or are
+ * not browsing a category archive page.
+ *
+ * @uses twentyten_term_list
+ *
+ * @since 0.7.0
+ * @return string
+ */
+
 if ( ! function_exists( 'twentyten_cat_list' ) ) :
 function twentyten_cat_list() {
        return twentyten_term_list( 'category', ', ', __( 'Posted in %s', 'twentyten' ), __( 'Also posted in %s', 'twentyten' ) );
 }
 endif;
 
+/**
+ * Returns the list of tags
+ *
+ * Returns the list of tags based on if we are or are not
+ * browsing a tag archive page
+ *
+ * @uses twentyten_term_list
+ *
+ * @since 0.7.0
+ * @return string
+ */
 if ( ! function_exists( 'twentyten_tag_list' ) ) :
 function twentyten_tag_list() {
        return twentyten_term_list( 'post_tag', ', ', __( 'Tagged %s', 'twentyten' ), __( 'Also tagged %s', 'twentyten' ) );
 }
 endif;
 
+/**
+ * Returns the list of taxonomy items in multiple ways
+ *
+ * Returns the list of taxonomy items differently based on
+ * if we are browsing a term archive page or a different
+ * type of page.  If browsing a term archive page and the
+ * post has no other taxonomied terms, it returns empty
+ *
+ * @since 0.7.0
+ * @return string
+ */
 if ( ! function_exists( 'twentyten_term_list' ) ) :
 function twentyten_term_list( $taxonomy, $glue = ', ', $text = '', $also_text = '' ) {
        global $wp_query, $post;
@@ -219,7 +328,12 @@
 }
 endif;
 
-// Register widgetized areas
+/**
+ * Register widgetized areas
+ *
+ * @since 0.7.0
+ * @uses register_sidebar
+ */
 if ( ! function_exists( 'twentyten_widgets_init' ) ) :
 function twentyten_widgets_init() {
        // Area 1
Index: wp-content/themes/twentyten/header.php
===================================================================
--- wp-content/themes/twentyten/header.php      (revision 13845)
+++ wp-content/themes/twentyten/header.php      (working copy)
@@ -1,3 +1,15 @@
+<?php
+/**
+ * The Header for our theme.
+ *
+ * Displays all of the <head> section and everything up till <div id="main">
+ *
+ * @since 0.7.0
+ * @package WordPress
+ * @subpackage 2010
+ */
+?>
+
 <!DOCTYPE html>
 <html <?php language_attributes(); ?>>
 <head>
@@ -3,4 +15,5 @@
        <meta charset="<?php bloginfo( 'charset' ); ?>" />
     <title><?php
+       // Returns the title based on the type of page being viewed
         if ( is_single() ) {
                        single_post_title(); echo ' | '; bloginfo( 'name' );
Index: wp-content/themes/twentyten/index.php
===================================================================
--- wp-content/themes/twentyten/index.php       (revision 13845)
+++ wp-content/themes/twentyten/index.php       (working copy)
@@ -1,3 +1,21 @@
+<?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
+ *
+ * @since 0.7.0
+ * @package WordPress
+ * @subpackage 2010
+ */
+ 
+?>
+ 
 <?php get_header(); ?>
 
                <div id="container">
@@ -14,4 +32,4 @@
                </div><!-- #container -->
 
 <?php get_sidebar(); ?>
-<?php get_footer(); ?>
+<?php get_footer(); ?>
\ No newline at end of file
Index: wp-content/themes/twentyten/loop.php
===================================================================
--- wp-content/themes/twentyten/loop.php        (revision 13845)
+++ wp-content/themes/twentyten/loop.php        (working copy)
@@ -1,3 +1,19 @@
+<?php
+/**
+ * The loop that displays posts
+ *
+ * The loop displays the posts and the post content.  See
+ * http://codex.wordpress.org/The_Loop to understand it and
+ * http://codex.wordpress.org/Template_Tags to understand
+ * the tags used in it.
+ *
+ * @since 0.7.0
+ * @package WordPress
+ * @subpackage 2010
+ */
+?>
+
+<?php /* Display navigation to next/previous pages when applicable  */ ?>
 <?php if ( $wp_query->max_num_pages > 1 ) : ?>
        <div id="nav-above" class="navigation">
                <div class="nav-previous"><?php next_posts_link( __( '<span class="meta-nav">&larr;</span> Older posts', 'twentyten' ) ); ?></div>
@@ -5,6 +21,7 @@
        </div><!-- #nav-above -->
 <?php endif; ?>
 
+<?php /* If there are no posts to display, such as an empty archive page  */ ?>
 <?php if ( ! have_posts() ) : ?>
        <div id="post-0" class="post error404 not-found">
                <h1 class="entry-title"><?php _e( 'Not Found', 'twentyten' ); ?></h1>
@@ -15,7 +32,10 @@
        </div><!-- #post-0 -->
 <?php endif; ?>
 
+<?php /* Start the Loop  */ ?>
 <?php while ( have_posts() ) : the_post(); ?>
+
+<?php /* How to Display posts in the Gallery Category  */ ?>
        <?php if ( in_category( 'Gallery' ) ) : ?>
                <div id="post-<?php the_ID(); ?>" <?php post_class(); ?>>
                        <h2 class="entry-title"><a href="<?php the_permalink(); ?>" title="<?php printf( esc_attr__( 'Permalink to %s', 'twentyten' ), the_title_attribute( 'echo=0' ) ); ?>" rel="bookmark"><?php the_title(); ?></a></h2>
@@ -62,7 +82,7 @@
                        </div><!-- #entry-utility -->
                </div>
 
-
+<?php /* How to display posts in the asides category */ ?>
        <?php elseif ( in_category( 'asides' ) ) : ?>
                <div id="post-<?php the_ID(); ?>" <?php post_class(); ?>>
        <?php if ( is_archive() || is_search() ) : //Only display Excerpts for archives & search ?>
@@ -92,7 +112,7 @@
                        </div><!-- #entry-utility -->
                </div><!-- #post-<?php the_ID(); ?> -->
 
-
+<?php /* How to display all other posts  */ ?>
        <?php else : ?>
                <div id="post-<?php the_ID(); ?>" <?php post_class(); ?>>
                        <h2 class="entry-title"><a href="<?php the_permalink(); ?>" title="<?php printf( esc_attr__( 'Permalink to %s', 'twentyten' ), the_title_attribute( 'echo=0' ) ); ?>" rel="bookmark"><?php the_title(); ?></a></h2>
@@ -139,6 +159,7 @@
        <?php endif; // if different categories queried ?>
 <?php endwhile; ?>
 
+<?php /* Display navigation to next/previous pages when applicable  */ ?>
 <?php if (  $wp_query->max_num_pages > 1 ) : ?>
                                <div id="nav-below" class="navigation">
                                        <div class="nav-previous"><?php next_posts_link( __( '<span class="meta-nav">&larr;</span> Older posts', 'twentyten' ) ); ?></div>
Index: wp-content/themes/twentyten/onecolumn-page.php
===================================================================
--- wp-content/themes/twentyten/onecolumn-page.php      (revision 13845)
+++ wp-content/themes/twentyten/onecolumn-page.php      (working copy)
@@ -1,11 +1,18 @@
-
 <?php
-/*
-Template Name: One column, no sidebar
-Description: A template with no sidebar
-*/
-get_header(); ?>
+/**
+ * Template Name: One column, no sidebar
+ *
+ * A custom page template without sidebar.
+ * Selectable from a dropdown menu on the edit page screen.
+ *
+ * @since 0.7.0
+ * @package WordPress
+ * @subpackage 2010
+ */
+?>
 
+<?php get_header(); ?>
+
                <div id="container" class="onecolumn">
                        <div id="content">
 
Index: wp-content/themes/twentyten/page.php
===================================================================
--- wp-content/themes/twentyten/page.php        (revision 13845)
+++ wp-content/themes/twentyten/page.php        (working copy)
@@ -1,3 +1,18 @@
+<?php
+/**
+ * The template used to display 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.
+ *
+ * @since 0.7.0
+ * @package WordPress
+ * @subpackage 2010
+ */
+?>
+
 <?php get_header(); ?>
 
                <div id="container">
Index: wp-content/themes/twentyten/search.php
===================================================================
--- wp-content/themes/twentyten/search.php      (revision 13845)
+++ wp-content/themes/twentyten/search.php      (working copy)
@@ -1,3 +1,13 @@
+<?php
+/**
+ * The Search Results template
+ *
+ * @since 0.7.0
+ * @package WordPress
+ * @subpackage 2010
+ */
+?>
+
 <?php get_header(); ?>
 
                <div id="container">
Index: wp-content/themes/twentyten/searchform.php
===================================================================
--- wp-content/themes/twentyten/searchform.php  (revision 13845)
+++ wp-content/themes/twentyten/searchform.php  (working copy)
@@ -1,3 +1,16 @@
+<?php
+/**
+ * The Search Form
+ *
+ * Optional file that allows displaying a custom search form
+ * when the get_search_form() template tag is used.
+ *
+ * @since 0.7.0
+ * @package WordPress
+ * @subpackage 2010
+ */
+?>
+
     <form id="searchform" name="searchform" method="get" action="<?php echo home_url(); ?>">
                <div>
                        <label for="s"><?php _e( 'Search', 'twentyten' ); ?></label>
Index: wp-content/themes/twentyten/sidebar-footer.php
===================================================================
--- wp-content/themes/twentyten/sidebar-footer.php      (revision 13845)
+++ wp-content/themes/twentyten/sidebar-footer.php      (working copy)
@@ -1,4 +1,14 @@
 <?php
+/**
+ * The Footer widget areas
+ *
+ * @since 0.7.0
+ * @package WordPress
+ * @subpackage 2010
+ */
+?>
+
+<?php
        if (
                is_active_sidebar( 'first-footer-widget-area' )  ||
                is_active_sidebar( 'second-footer-widget-area' ) ||
Index: wp-content/themes/twentyten/sidebar.php
===================================================================
--- wp-content/themes/twentyten/sidebar.php     (revision 13845)
+++ wp-content/themes/twentyten/sidebar.php     (working copy)
@@ -1,3 +1,13 @@
+<?php
+/**
+ * The Sidebar containing the primary and secondary widget areas
+ *
+ * @since 0.7.0
+ * @package WordPress
+ * @subpackage 2010
+ */
+?>
+
                <div id="primary" class="widget-area">
                        <ul class="xoxo">
 <?php if ( ! dynamic_sidebar( 'primary-widget-area' ) ) : // begin primary widget area ?>
Index: wp-content/themes/twentyten/single.php
===================================================================
--- wp-content/themes/twentyten/single.php      (revision 13845)
+++ wp-content/themes/twentyten/single.php      (working copy)
@@ -1,3 +1,13 @@
+<?php
+/**
+ * The Template used to display all single posts
+ *
+ * @since 0.7.0
+ * @package WordPress
+ * @subpackage 2010
+ */
+?>
+
 <?php get_header(); ?>
 
                <div id="container">
Index: wp-content/themes/twentyten/tag.php
===================================================================
--- wp-content/themes/twentyten/tag.php (revision 13845)
+++ wp-content/themes/twentyten/tag.php (working copy)
@@ -1,3 +1,13 @@
+<?php
+/**
+ * The template used to display Tag Archive pages
+ *
+ * @since 0.7.0
+ * @package WordPress
+ * @subpackage 2010
+ */
+?>
+
 <?php get_header(); ?>
 
                <div id="container">