From f15c863ba1a2d461b3643263e0ceea6ed5aac0a2 Mon Sep 17 00:00:00 2001
From: Peter Westwood <westi@git.wordpress.org>
Date: Sat, 27 Sep 2008 09:49:27 +0000
Subject: [PATCH] phpdoc for the default and classic themes. See #7550 props
 jacobsantos.

git-svn-id: https://develop.svn.wordpress.org/trunk@8999 602fd350-edb4-49c9-b593-d223f7449a82
---
 wp-content/themes/classic/comments-popup.php    |  5 +++++
 wp-content/themes/classic/comments.php          |  8 +++++++-
 wp-content/themes/classic/footer.php            |  6 ++++++
 wp-content/themes/classic/functions.php         | 14 +++++++++-----
 wp-content/themes/classic/header.php            |  6 ++++++
 wp-content/themes/classic/index.php             |  4 ++++
 wp-content/themes/classic/sidebar.php           |  7 ++++++-
 wp-content/themes/default/404.php               |  9 ++++++++-
 wp-content/themes/default/archive.php           |  9 ++++++++-
 wp-content/themes/default/archives.php          |  4 ++++
 wp-content/themes/default/comments-popup.php    |  5 +++++
 wp-content/themes/default/comments.php          |  8 +++++++-
 wp-content/themes/default/footer.php            |  6 ++++++
 wp-content/themes/default/functions.php         |  6 ++++++
 wp-content/themes/default/header.php            |  6 ++++++
 wp-content/themes/default/image.php             | 11 +++++++++--
 wp-content/themes/default/images/header-img.php |  5 +++++
 wp-content/themes/default/index.php             |  8 +++++++-
 wp-content/themes/default/links.php             |  5 +++++
 wp-content/themes/default/page.php              |  8 +++++++-
 wp-content/themes/default/search.php            |  8 +++++++-
 wp-content/themes/default/searchform.php        |  6 ++++++
 wp-content/themes/default/sidebar.php           |  6 ++++++
 wp-content/themes/default/single.php            |  9 ++++++++-
 24 files changed, 153 insertions(+), 16 deletions(-)

diff --git a/wp-content/themes/classic/comments-popup.php b/wp-content/themes/classic/comments-popup.php
index b28156436d..0401593492 100644
--- a/wp-content/themes/classic/comments-popup.php
+++ b/wp-content/themes/classic/comments-popup.php
@@ -1,4 +1,9 @@
 <?php
+/**
+ * @package WordPress
+ * @subpackage Classic_Theme
+ */
+
 /* Don't remove these lines. */
 add_filter('comment_text', 'popuplinks');
 while( have_posts()) : the_post();
diff --git a/wp-content/themes/classic/comments.php b/wp-content/themes/classic/comments.php
index dc995776fa..d1b6ef58c5 100644
--- a/wp-content/themes/classic/comments.php
+++ b/wp-content/themes/classic/comments.php
@@ -1,4 +1,10 @@
-<?php if ( post_password_required() ) : ?>
+<?php
+/**
+ * @package WordPress
+ * @subpackage Classic_Theme
+ */
+
+if ( post_password_required() ) : ?>
 <p><?php _e('Enter your password to view comments.'); ?></p>
 <?php return; endif; ?>
 
diff --git a/wp-content/themes/classic/footer.php b/wp-content/themes/classic/footer.php
index 0894f78eda..819ed428a3 100644
--- a/wp-content/themes/classic/footer.php
+++ b/wp-content/themes/classic/footer.php
@@ -1,3 +1,9 @@
+<?php
+/**
+ * @package WordPress
+ * @subpackage Classic_Theme
+ */
+?>
 <!-- begin footer -->
 </div>
 
diff --git a/wp-content/themes/classic/functions.php b/wp-content/themes/classic/functions.php
index a63850cc50..40d4a46f8e 100644
--- a/wp-content/themes/classic/functions.php
+++ b/wp-content/themes/classic/functions.php
@@ -1,10 +1,14 @@
 <?php
+/**
+ * @package WordPress
+ * @subpackage Classic_Theme
+ */
 if ( function_exists('register_sidebar') )
 	register_sidebar(array(
-        'before_widget' => '<li id="%1$s" class="widget %2$s">',
-        'after_widget' => '</li>',
-        'before_title' => '',
-        'after_title' => '',
-    ));
+		'before_widget' => '<li id="%1$s" class="widget %2$s">',
+		'after_widget' => '</li>',
+		'before_title' => '',
+		'after_title' => '',
+	));
 
 ?>
diff --git a/wp-content/themes/classic/header.php b/wp-content/themes/classic/header.php
index 4a3e0b4f46..db848a253c 100644
--- a/wp-content/themes/classic/header.php
+++ b/wp-content/themes/classic/header.php
@@ -1,3 +1,9 @@
+<?php
+/**
+ * @package WordPress
+ * @subpackage Classic_Theme
+ */
+?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" <?php language_attributes(); ?>>
 
diff --git a/wp-content/themes/classic/index.php b/wp-content/themes/classic/index.php
index 652ec0597f..6cb8c63f60 100644
--- a/wp-content/themes/classic/index.php
+++ b/wp-content/themes/classic/index.php
@@ -1,4 +1,8 @@
 <?php
+/**
+ * @package WordPress
+ * @subpackage Classic_Theme
+ */
 get_header();
 ?>
 
diff --git a/wp-content/themes/classic/sidebar.php b/wp-content/themes/classic/sidebar.php
index e4a680abb6..0c8a12eac2 100644
--- a/wp-content/themes/classic/sidebar.php
+++ b/wp-content/themes/classic/sidebar.php
@@ -1,4 +1,9 @@
-
+<?php
+/**
+ * @package WordPress
+ * @subpackage Classic_Theme
+ */
+?>
 <!-- begin sidebar -->
 <div id="menu">
 
diff --git a/wp-content/themes/default/404.php b/wp-content/themes/default/404.php
index 01a8e8a617..f9fee472ad 100644
--- a/wp-content/themes/default/404.php
+++ b/wp-content/themes/default/404.php
@@ -1,4 +1,11 @@
-<?php get_header(); ?>
+<?php
+/**
+ * @package WordPress
+ * @subpackage Default_Theme
+ */
+
+get_header();
+?>
 
 	<div id="content" class="narrowcolumn">
 
diff --git a/wp-content/themes/default/archive.php b/wp-content/themes/default/archive.php
index 9257ddddaa..f854465dd0 100644
--- a/wp-content/themes/default/archive.php
+++ b/wp-content/themes/default/archive.php
@@ -1,4 +1,11 @@
-<?php get_header(); ?>
+<?php
+/**
+ * @package WordPress
+ * @subpackage Default_Theme
+ */
+
+get_header();
+?>
 
 	<div id="content" class="narrowcolumn">
 
diff --git a/wp-content/themes/default/archives.php b/wp-content/themes/default/archives.php
index dba8dbd149..f974486805 100644
--- a/wp-content/themes/default/archives.php
+++ b/wp-content/themes/default/archives.php
@@ -1,4 +1,8 @@
 <?php
+/**
+ * @package WordPress
+ * @subpackage Default_Theme
+ */
 /*
 Template Name: Archives
 */
diff --git a/wp-content/themes/default/comments-popup.php b/wp-content/themes/default/comments-popup.php
index 5f739208fa..6a5a869e51 100644
--- a/wp-content/themes/default/comments-popup.php
+++ b/wp-content/themes/default/comments-popup.php
@@ -1,4 +1,9 @@
 <?php
+/**
+ * @package WordPress
+ * @subpackage Default_Theme
+ */
+
 /* Don't remove these lines. */
 add_filter('comment_text', 'popuplinks');
 while ( have_posts()) : the_post();
diff --git a/wp-content/themes/default/comments.php b/wp-content/themes/default/comments.php
index 3cd73ee54d..7832a00cb2 100644
--- a/wp-content/themes/default/comments.php
+++ b/wp-content/themes/default/comments.php
@@ -1,4 +1,10 @@
-<?php // Do not delete these lines
+<?php
+/**
+ * @package WordPress
+ * @subpackage Default_Theme
+ */
+
+// Do not delete these lines
 	if (!empty($_SERVER['SCRIPT_FILENAME']) && 'comments.php' == basename($_SERVER['SCRIPT_FILENAME']))
 		die ('Please do not load this page directly. Thanks!');
 
diff --git a/wp-content/themes/default/footer.php b/wp-content/themes/default/footer.php
index 91cb69fdc9..49ab67660d 100644
--- a/wp-content/themes/default/footer.php
+++ b/wp-content/themes/default/footer.php
@@ -1,3 +1,9 @@
+<?php
+/**
+ * @package WordPress
+ * @subpackage Default_Theme
+ */
+?>
 
 <hr />
 <div id="footer">
diff --git a/wp-content/themes/default/functions.php b/wp-content/themes/default/functions.php
index e0451e7df4..9008dfa5c0 100644
--- a/wp-content/themes/default/functions.php
+++ b/wp-content/themes/default/functions.php
@@ -1,4 +1,9 @@
 <?php
+/**
+ * @package WordPress
+ * @subpackage Default_Theme
+ */
+
 if ( function_exists('register_sidebar') )
     register_sidebar(array(
         'before_widget' => '<li id="%1$s" class="widget %2$s">',
@@ -7,6 +12,7 @@ if ( function_exists('register_sidebar') )
         'after_title' => '</h2>',
     ));
 
+/** @ignore */
 function kubrick_head() {
 	$head = "<style type='text/css'>\n<!--";
 	$output = '';
diff --git a/wp-content/themes/default/header.php b/wp-content/themes/default/header.php
index 6fdfdd0047..f967bde3c9 100644
--- a/wp-content/themes/default/header.php
+++ b/wp-content/themes/default/header.php
@@ -1,3 +1,9 @@
+<?php
+/**
+ * @package WordPress
+ * @subpackage Default_Theme
+ */
+?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" <?php language_attributes(); ?>>
 
diff --git a/wp-content/themes/default/image.php b/wp-content/themes/default/image.php
index 5e039806af..80dad8ace8 100644
--- a/wp-content/themes/default/image.php
+++ b/wp-content/themes/default/image.php
@@ -1,4 +1,11 @@
-<?php get_header(); ?>
+<?php
+/**
+ * @package WordPress
+ * @subpackage Default_Theme
+ */
+
+get_header();
+?>
 
 	<div id="content" class="widecolumn">
 
@@ -8,7 +15,7 @@
 			<h2><a href="<?php echo get_permalink($post->post_parent); ?>" rev="attachment"><?php echo get_the_title($post->post_parent); ?></a> &raquo; <?php the_title(); ?></h2>
 			<div class="entry">
 				<p class="attachment"><a href="<?php echo wp_get_attachment_url($post->ID); ?>"><?php echo wp_get_attachment_image( $post->ID, 'medium' ); ?></a></p>
-                <div class="caption"><?php if ( !empty($post->post_excerpt) ) the_excerpt(); // this is the "caption" ?></div>
+				<div class="caption"><?php if ( !empty($post->post_excerpt) ) the_excerpt(); // this is the "caption" ?></div>
 
 				<?php the_content('<p class="serif">Read the rest of this entry &raquo;</p>'); ?>
 
diff --git a/wp-content/themes/default/images/header-img.php b/wp-content/themes/default/images/header-img.php
index 75629d7011..50bd3c370c 100644
--- a/wp-content/themes/default/images/header-img.php
+++ b/wp-content/themes/default/images/header-img.php
@@ -1,5 +1,10 @@
 <?php
+/**
+ * @package WordPress
+ * @subpackage Default_Theme
+ */
 
+/** @ignore */
 $img = 'kubrickheader.jpg';
 
 // If we don't have image processing support, redirect.
diff --git a/wp-content/themes/default/index.php b/wp-content/themes/default/index.php
index 47c13fc516..53175843a4 100644
--- a/wp-content/themes/default/index.php
+++ b/wp-content/themes/default/index.php
@@ -1,4 +1,10 @@
-<?php get_header(); ?>
+<?php
+/**
+ * @package WordPress
+ * @subpackage Default_Theme
+ */
+
+get_header(); ?>
 
 	<div id="content" class="narrowcolumn">
 
diff --git a/wp-content/themes/default/links.php b/wp-content/themes/default/links.php
index e253e09ba0..81fdc008db 100644
--- a/wp-content/themes/default/links.php
+++ b/wp-content/themes/default/links.php
@@ -1,4 +1,9 @@
 <?php
+/**
+ * @package WordPress
+ * @subpackage Default_Theme
+ */
+
 /*
 Template Name: Links
 */
diff --git a/wp-content/themes/default/page.php b/wp-content/themes/default/page.php
index a6e3ca6a2f..bd77efb679 100644
--- a/wp-content/themes/default/page.php
+++ b/wp-content/themes/default/page.php
@@ -1,4 +1,10 @@
-<?php get_header(); ?>
+<?php
+/**
+ * @package WordPress
+ * @subpackage Default_Theme
+ */
+
+get_header(); ?>
 
 	<div id="content" class="narrowcolumn">
 
diff --git a/wp-content/themes/default/search.php b/wp-content/themes/default/search.php
index 17ee99c5e1..fd1fabf9f1 100644
--- a/wp-content/themes/default/search.php
+++ b/wp-content/themes/default/search.php
@@ -1,4 +1,10 @@
-<?php get_header(); ?>
+<?php
+/**
+ * @package WordPress
+ * @subpackage Default_Theme
+ */
+
+get_header(); ?>
 
 	<div id="content" class="narrowcolumn">
 
diff --git a/wp-content/themes/default/searchform.php b/wp-content/themes/default/searchform.php
index 300a1c4bf0..bddaf9a80f 100644
--- a/wp-content/themes/default/searchform.php
+++ b/wp-content/themes/default/searchform.php
@@ -1,3 +1,9 @@
+<?php
+/**
+ * @package WordPress
+ * @subpackage Default_Theme
+ */
+?>
 <form method="get" id="searchform" action="<?php bloginfo('url'); ?>/">
 <label class="hidden" for="s"><?php _e('Search for:'); ?></label>
 <div><input type="text" value="<?php the_search_query(); ?>" name="s" id="s" />
diff --git a/wp-content/themes/default/sidebar.php b/wp-content/themes/default/sidebar.php
index 36dea86f62..a85cd8c21d 100644
--- a/wp-content/themes/default/sidebar.php
+++ b/wp-content/themes/default/sidebar.php
@@ -1,3 +1,9 @@
+<?php
+/**
+ * @package WordPress
+ * @subpackage Default_Theme
+ */
+?>
 	<div id="sidebar">
 		<ul>
 			<?php 	/* Widgetized sidebar, if you have the plugin installed. */
diff --git a/wp-content/themes/default/single.php b/wp-content/themes/default/single.php
index 5c09870e1a..5658bbf45c 100644
--- a/wp-content/themes/default/single.php
+++ b/wp-content/themes/default/single.php
@@ -1,4 +1,11 @@
-<?php get_header(); ?>
+<?php
+/**
+ * @package WordPress
+ * @subpackage Default_Theme
+ */
+
+get_header();
+?>
 
 	<div id="content" class="widecolumn">