Some documentation

localhost8080 · localhost8080 · commit b93798f135e6 · 2014-10-04T12:54:37.000+01:00
diff --git a/category.php b/category.php
@@ -1,7 +1,12 @@
 <?php
+/**
+ * category archives template part
+ */
+
 /**
  * category archives template part
  *
+ * @link http://codex.wordpress.org/Template_Hierarchy
  * @package multiloquent\template_parts
  */
 get_header();
diff --git a/comments.php b/comments.php
@@ -1,10 +1,14 @@
 <?php
-/** 
+/**
+ * comment form
+ */
+
+/**
  * comment template part.
- * this is a direct lift of the comments from shoestrap; 
+ * this is a direct lift of the comments from shoestrap;
  * I personally use disqus for my comments, but this comment  system was already done :D
  * http://shoestrap.org/
- * 
+ *
  * @package multiloquent\template_parts
  */
 if (post_password_required()) {
@@ -18,7 +22,7 @@
             <ol class="comment-list">
               <?php wp_list_comments(); ?>
           </ol>
-          
+
           <?php if (get_comment_pages_count() > 1 && get_option('page_comments')) { ?>
           <nav>
             <ul class="pager">
diff --git a/featuredimage.php b/featuredimage.php
@@ -1,6 +1,10 @@
 <?php
 /**
- * template part to output a featured image
+ * output the featured image, or a default image if none set
+ */
+
+/**
+ * template part to output a featured image or a default image if none set
  *
  * @package multiloquent\template_parts
  */
diff --git a/footer.php b/footer.php
@@ -1,7 +1,11 @@
-<?php 
+<?php
+/**
+ * multiloquent theme footer
+ */
+
 /**
  * footer template part
- * 
+ *
  * @package multiloquent\template_parts
  */
 ?>
diff --git a/front-page.php b/front-page.php
@@ -1,7 +1,13 @@
 <?php
+/**
+ * template for static homepage if set in options
+ */
+
 /**
  * home page template part if static page selected as homepage
  *
+ * @link http://codex.wordpress.org/Template_Hierarchy
+ *
  * @package multiloquent\template_parts
  */
 
diff --git a/header.php b/header.php
@@ -1,7 +1,11 @@
 <?php
+/**
+ * Header template part
+ */
+
 /**
  * header template part
- * 
+ *
  * @package multiloquent\template_parts
  */
 ?><!DOCTYPE html>
@@ -21,4 +25,4 @@
 <body <?php body_class();?>>
 	<div class="holder">
 		<div class="wrapper">
-			
+
diff --git a/home.php b/home.php
@@ -1,7 +1,12 @@
 <?php
+/**
+ * homepage when set to display blog posts on homepage
+ */
+
 /**
  * this is the template for the home page when its set to display blog posts
  *
+ * @link http://codex.wordpress.org/Template_Hierarchy
  * @package multiloquent\template_parts
  */
 
diff --git a/index.php b/index.php
@@ -1,7 +1,11 @@
 <?php
+/**
+ * fallback if no other archive pages are found
+ */
+
 /**
  * fallback page if no other index page found
- *
+ * @link http://codex.wordpress.org/Template_Hierarchy
  * @package multiloquent\template_parts
  */
 
diff --git a/metadata.php b/metadata.php
@@ -1,8 +1,12 @@
-<?php 
+<?php
+/**
+ * generate metadata for posts
+ */
+
 /**
  * generate the metadata snippet.
  * used in the breadcrumbs
- * 
+ *
  * @package multiloquent\template_parts
  */
 
diff --git a/navigation.php b/navigation.php
@@ -1,13 +1,17 @@
-<?php 
+<?php
+/**
+ * nav bar
+ */
+
 /**
  * navigation template part
- * 
+ *
  * @package multiloquent\template_parts
  */
 ?>
 <nav role="navigation" class="navbar navbar-default navbar-fixed-top">
 	<div class="navbar-header">
-		<a title="navigation menu" href="javascript:void(0);" class="navbar-brand sidebar-toggle"><span class="fa fa-bars"></span></a>  
-		<?php echo '<h2><a class="navbar-brand title_text" title="'. get_bloginfo('name').'" href="'. esc_url(home_url('/')) .'">'. get_bloginfo('name').'</a></h2>';?>       
+		<a title="navigation menu" href="javascript:void(0);" class="navbar-brand sidebar-toggle"><span class="fa fa-bars"></span></a>
+		<?php echo '<h2><a class="navbar-brand title_text" title="'. get_bloginfo('name').'" href="'. esc_url(home_url('/')) .'">'. get_bloginfo('name').'</a></h2>';?>
 	</div>
 </nav>
diff --git a/page.php b/page.php
@@ -1,7 +1,12 @@
 <?php
+/**
+ * static page template
+ */
+
 /**
  * static page template part
  *
+ * @link http://codex.wordpress.org/Template_Hierarchy
  * @package multiloquent\template_parts
  */
 
diff --git a/search.php b/search.php
@@ -1,7 +1,12 @@
-<?php 
+<?php
+/**
+ * search results page
+ */
+
 /**
  * search result template part
- * 
+ *
+ * @link http://codex.wordpress.org/Template_Hierarchy
  * @package multiloquent\template_parts
  */
 
diff --git a/searchform.php b/searchform.php
@@ -1,19 +1,23 @@
-<?php 
+<?php
+/**
+ * the search form
+ */
+
 /**
  * search form.
  * wordpress template part
- * 
+ *
  * @package multiloquent\template_parts
  */
-  
+
 ?>
 <form action="<?php echo esc_url(home_url('/')); ?>" id="search_form" class="mb" method="post">
 	<div class="input-group">
-		<input type="text" id="s" name="s" autocomplete="off" placeholder="Search" class="form-control"> 
+		<input type="text" id="s" name="s" autocomplete="off" placeholder="Search" class="form-control">
 		<input type="hidden" value="the_search_text" name="action">
 		<span class="input-group-addon">
 			<label title="search" for="s" class="" style="margin:0"><span class="fa fa-search fafw"></span></label>
 		</span>
         <?php wp_nonce_field('search','search'); ?>
-	</div>   
+	</div>
 </form>
diff --git a/sidebar.php b/sidebar.php
@@ -1,7 +1,11 @@
 <?php
 /**
- * sidebar template part 
- * 
+ * the sidebar for multiloquent
+ */
+
+/**
+ * sidebar template part
+ *
  * @package multiloquent\template_parts
  */
 ?>
diff --git a/single.php b/single.php
@@ -1,4 +1,8 @@
 <?php
+/**
+ * template for blog posts
+ */
+
 /**
  * single post template part
  *
diff --git a/social.php b/social.php
@@ -1,4 +1,7 @@
 <?php
+/**
+ * the social media things
+ */
 
 /**
 * social media template part
diff --git a/tag.php b/tag.php
@@ -1,7 +1,12 @@
 <?php
+/**
+ * template for tag archives
+ */
+
 /**
  * tag archive template part
  *
+ * @link http://codex.wordpress.org/Template_Hierarchy
  * @package multiloquent\template_parts
  */
 
