Improve inline documentation and code cleanup

jayj · Aug 26, 2013 · 6a1de2d · 6a1de2d
1 parent 5eeb3ee
commit 6a1de2d
Show file tree

Hide file tree

Showing 46 changed files with 413 additions and 443 deletions.
diff --git a/404.php b/404.php
@@ -5,13 +5,10 @@
  * The 404 template is used when a reader visits an invalid URL on your site. By default, the template will
  * display a generic message.
  *
- * @package Cakifo
+ * @package    Cakifo
  * @subpackage Template
- * @link http://codex.wordpress.org/Creating_an_Error_404_Page
  */
 
-@header( 'HTTP/1.1 404 Not found', true, 404 );
-
 /**
  * Include the header template part file
  *
@@ -26,34 +23,34 @@
 
 		<?php do_atomic( 'open_main' ); // cakifo_open_main ?>
 
-			<article id="post-0" class="<?php hybrid_entry_class(); ?>">
+		<article id="post-0" class="<?php hybrid_entry_class(); ?>">
 
-				<header class="entry-header">
-					<h1 class="error-404-title entry-title"><?php _e( "Whoah! 404 error! We can't find the page!", 'cakifo' ); ?></h1>
-				</header> <!-- .entry-header -->
+			<header class="entry-header">
+				<h1 class="error-404-title entry-title"><?php _e( "Whoah! 404 error! We can't find the page!", 'cakifo' ); ?></h1>
+			</header> <!-- .entry-header -->
 
-				<div class="entry-content">
-					<p>
-						<?php printf( __( "You tried going to %s but the page no longer exists. All is not lost!  Perhaps searching, or one of the links below, can help.", 'cakifo' ), '<code>' . esc_html( $_SERVER['REQUEST_URI'] ) . '</code>' ); ?>
-					</p>
+			<div class="entry-content">
+				<p>
+					<?php printf( __( "You tried going to %s but the page no longer exists. All is not lost!  Perhaps searching, or one of the links below, can help.", 'cakifo' ), '<code>' . esc_html( $_SERVER['REQUEST_URI'] ) . '</code>' ); ?>
+				</p>
 
-					<?php get_search_form(); // Loads the searchform.php template ?>
+				<?php get_search_form(); // Loads the searchform.php template ?>
 
-					<?php do_atomic( '404_content' ); // You can add more content here by using the `cakifo_404_content` action ?>
-				</div> <!-- .entry-content -->
+				<?php do_atomic( '404_content' ); // You can add more content here by using the `cakifo_404_content` action ?>
+			</div> <!-- .entry-content -->
 
-			</article> <!-- .hentry -->
+		</article> <!-- .hentry -->
 
-			<?php
-				/**
-				 * Include the Error Page widgets "sidebar" template part file
-				 *
-				 * Child Themes can replace this template part file globally,
-				 * via `sidebar.php`, or in the Error 404 Page context only, via
-				 * `sidebar-404.php`
-				 */
-				get_sidebar( '404' );
-			?>
+		<?php
+			/**
+			 * Include the Error Page widgets "sidebar" template part file
+			 *
+			 * Child Themes can replace this template part file globally,
+			 * via `sidebar.php`, or in the Error 404 Page context only, via
+			 * `sidebar-404.php`
+			 */
+			get_sidebar( '404' );
+		?>
 
 		<?php do_atomic( 'close_main' ); // cakifo_close_main ?>
 

diff --git a/archive.php b/archive.php
@@ -4,7 +4,7 @@
  *
  * The archive template is the default template used for archives pages without a more specific template.
  *
- * @package Cakifo
+ * @package    Cakifo
  * @subpackage Template
  */
 

diff --git a/attachment.php b/attachment.php
@@ -5,9 +5,8 @@
  * This is the default attachment template.  It is used when visiting the singular view of a post attachment
  * page (images, videos, audio, etc.).
  *
- * @package Cakifo
+ * @package    Cakifo
  * @subpackage Template
- * @since Cakifo 1.0.0
  */
 
 get_header(); // Loads the header.php template ?>

diff --git a/comments.php b/comments.php
@@ -5,11 +5,11 @@
  * Lists comments and calls the comment form.  Individual comments have their own templates.  The
  * hierarchy for these templates is `$comment_type.php, comment.php`.
  *
- * @package Cakifo
+ * @package    Cakifo
  * @subpackage Template
  */
 
-/*
+/**
  * If the current post is protected by a password and
  * the visitor has not yet entered the password we will
  * return early without loading the comments.

diff --git a/content-aside.php b/content-aside.php
@@ -6,9 +6,8 @@
  *
  * This can be overridden in child themes with content-aside.php
  *
- * @package Cakifo
+ * @package    Cakifo
  * @subpackage Template
- * @since Cakifo 1.6.0
  */
 
 do_atomic( 'before_entry' ); // cakifo_before_entry ?>

diff --git a/content-attachment.php b/content-attachment.php
@@ -6,9 +6,8 @@
  *
  * This can be overridden in child themes with content-attachment.php
  *
- * @package Cakifo
+ * @package    Cakifo
  * @subpackage Template
- * @since Cakifo 1.6.0
  */
 
 do_atomic( 'before_entry' ); // cakifo_before_entry ?>
@@ -24,9 +23,7 @@
 		</header> <!-- .entry-header -->
 
 		<?php
-			/**
-			 * Get the thumbnail
-			 */
+			// Get the thumbnail.
 			if ( current_theme_supports( 'get-the-image' ) )
 				get_the_image(
 					array(
@@ -60,9 +57,7 @@
 		</header> <!-- .entry-header -->
 
 		<?php
-			/**
-			 * Get the thumbnail
-			 */
+			// Get the thumbnail.
 			if ( current_theme_supports( 'get-the-image' ) )
 				get_the_image(
 					array(

diff --git a/content-audio.php b/content-audio.php
@@ -6,9 +6,8 @@
  *
  * This can be overridden in child themes with content-audio.php
  *
- * @package Cakifo
+ * @package    Cakifo
  * @subpackage Template
- * @since Cakifo 1.6.0
  */
 
 do_atomic( 'before_entry' ); // cakifo_before_entry ?>

diff --git a/content-chat.php b/content-chat.php
@@ -6,9 +6,8 @@
  *
  * This can be overridden in child themes with `content-chat.php`
  *
- * @package Cakifo
+ * @package    Cakifo
  * @subpackage Template
- * @since Cakifo 1.6.0
  */
 
 do_atomic( 'before_entry' ); // cakifo_before_entry ?>

diff --git a/content-gallery.php b/content-gallery.php
@@ -6,9 +6,8 @@
  *
  * This can be overridden in child themes with `content-gallery.php`
  *
- * @package Cakifo
+ * @package    Cakifo
  * @subpackage Template
- * @since Cakifo 1.6.0
  */
 
 do_atomic( 'before_entry' ); // cakifo_before_entry ?>

diff --git a/content-image.php b/content-image.php
@@ -6,9 +6,8 @@
  *
  * This can be overridden in child themes with `content-image.php`
  *
- * @package Cakifo
+ * @package    Cakifo
  * @subpackage Template
- * @since Cakifo 1.6.0
  */
 
 do_atomic( 'before_entry' ); // cakifo_before_entry ?>

diff --git a/content-intro.php b/content-intro.php
@@ -2,9 +2,8 @@
 /**
  * The template for displaying page content in the template-front-page.php page template
  *
- * @package Cakifo
+ * @package    Cakifo
  * @subpackage Template
- * @since Cakifo 1.6.0
  */
 
 do_atomic( 'before_intro' ); // cakifo_before_intro ?>

diff --git a/content-link.php b/content-link.php
@@ -6,9 +6,8 @@
  *
  * This can be overridden in child themes with content-link.php
  *
- * @package Cakifo
+ * @package    Cakifo
  * @subpackage Template
- * @since Cakifo 1.6.0
  */
 
 do_atomic( 'before_entry' ); // cakifo_before_entry ?>
@@ -26,14 +25,13 @@
 		</header> <!-- .entry-header -->
 
 		<?php
-			/**
-			 * Get the thumbnail
-			 */
-			if ( current_theme_supports( 'get-the-image' ) )
+			// Get the thumbnail.
+			if ( current_theme_supports( 'get-the-image' ) ) {
 				get_the_image( array(
 					'size'       => 'thumbnail',
 					'attachment' => false
 				));
+			}
 		?>
 
 		<div class="entry-content">
@@ -55,14 +53,13 @@
 		</header> <!-- .entry-header -->
 
 		<?php
-			/**
-			 * Get the thumbnail
-			 */
-			if ( current_theme_supports( 'get-the-image' ) )
+			// Get the thumbnail.
+			if ( current_theme_supports( 'get-the-image' ) ) {
 				get_the_image( array(
 						'size'       => 'thumbnail',
 						'attachment' => false
 				));
+			}
 		?>
 
 		<div class="entry-content">

diff --git a/content-quote.php b/content-quote.php
@@ -6,9 +6,8 @@
  *
  * This can be overridden in child themes with `content-quote.php`
  *
- * @package Cakifo
+ * @package    Cakifo
  * @subpackage Template
- * @since Cakifo 1.6.0
  */
 
 do_atomic( 'before_entry' ); // cakifo_before_entry ?>

diff --git a/content-video.php b/content-video.php
@@ -6,9 +6,8 @@
  *
  * This can be overridden in child themes with `content-video.php`
  *
- * @package Cakifo
+ * @package    Cakifo
  * @subpackage Template
- * @since Cakifo 1.6.0
  */
 
 do_atomic( 'before_entry' ); // cakifo_before_entry ?>

diff --git a/content.php b/content.php
@@ -10,9 +10,8 @@
  * be used if it exists and we ask for the loop with:
  * <code>get_template_part( 'loop', 'index' );</code>
  *
- * @package Cakifo
+ * @package    Cakifo
  * @subpackage Template
- * @since Cakifo 1.1.0
  */
 
 do_atomic( 'before_entry' ); // cakifo_before_entry ?>
@@ -29,14 +28,13 @@
 		</header> <!-- .entry-header -->
 
 		<?php
-			/**
-			 * Get the thumbnail
-			 */
-			if ( current_theme_supports( 'get-the-image' ) )
+			// Get the thumbnail.
+			if ( current_theme_supports( 'get-the-image' ) ) {
 				get_the_image( array(
 					'size'       => 'thumbnail',
 					'attachment' => false
 				));
+			}
 		?>
 
 		<div class="entry-content">
@@ -58,14 +56,13 @@
 		</header> <!-- .entry-header -->
 
 		<?php
-			/**
-			 * Get the thumbnail
-			 */
-			if ( current_theme_supports( 'get-the-image' ) )
+			// Get the thumbnail.
+			if ( current_theme_supports( 'get-the-image' ) ) {
 				get_the_image( array(
 					'size'       => 'thumbnail',
 					'attachment' => false
 				));
+			}
 		?>
 
 		<?php if ( is_archive() || is_search() ) : ?>

diff --git a/footer.php b/footer.php
@@ -7,7 +7,7 @@
  * wrapper, which is opened with the header.php file. It also executes key functions needed
  * by the theme, child themes, and plugins.
  *
- * @package Cakifo
+ * @package    Cakifo
  * @subpackage Template
  */
 ?>
@@ -39,8 +39,9 @@
 				 * A sidebar in the footer? Yep. You can can customize your footer
 				 * with three columns of widgets.
 				 */
-				if ( ! is_404() )
+				if ( ! is_404() ) {
 					get_sidebar( 'subsidiary' );
+				}
 			?>
 
 		<?php do_atomic( 'close_footer' ); // cakifo_close_footer ?>