Permalink
Browse files

Updated documentation in comments at the top of files.

I tried to standardize and expand the documentation and links to
codex.wordpress.org in the comments at the top of most files.
  • Loading branch information...
1 parent 5bb0534 commit de9c9888b7bf0e5fd60dd000e7efd579920d3d45 @PJ-Finlay PJ-Finlay committed Jul 1, 2015
View
@@ -2,6 +2,8 @@
/**
* The template for displaying 404 pages (not found).
*
+ * @link https://codex.wordpress.org/Creating_an_Error_404_Page
+ *
* @package _s
*/
View
@@ -2,7 +2,7 @@
/**
* The template for displaying archive pages.
*
- * Learn more: http://codex.wordpress.org/Template_Hierarchy
+ * @link https://codex.wordpress.org/Template_Hierarchy
*
* @package _s
*/
View
@@ -2,9 +2,11 @@
/**
* The template for displaying comments.
*
- * The area of the page that contains both current comments
+ * This is the template that displays the area of the page that contains both the current comments
* and the comment form.
*
+ * @link https://codex.wordpress.org/Template_Hierarchy
+ *
* @package _s
*/
View
@@ -2,7 +2,9 @@
/**
* The template for displaying the footer.
*
- * Contains the closing of the #content div and all content after
+ * Contains the closing of the #content div and all content after.
+ *
+ * @link https://developer.wordpress.org/themes/basics/template-files/#template-partials
*
* @package _s
*/
View
@@ -1,6 +1,8 @@
<?php
/**
- * _s functions and definitions
+ * _s functions and definitions.
+ *
+ * @link https://codex.wordpress.org/Functions_File_Explained
*
* @package _s
*/
View
@@ -2,7 +2,9 @@
/**
* The header for our theme.
*
- * Displays all of the <head> section and everything up till <div id="content">
+ * This is the template that displays all of the <head> section and everything up until <div id="content">
+ *
+ * @link https://developer.wordpress.org/themes/basics/template-files/#template-partials
*
* @package _s
*/
@@ -1,7 +1,6 @@
<?php
/**
- * Sample implementation of the Custom Header feature
- * http://codex.wordpress.org/Custom_Headers
+ * Sample implementation of the Custom Header feature.
*
* You can add an optional custom header image to header.php like so ...
*
@@ -11,6 +10,8 @@
</a>
<?php endif; // End header image check. ?>
*
+ * @link http://codex.wordpress.org/Custom_Headers
+ *
* @package _s
*/
View
@@ -1,6 +1,6 @@
<?php
/**
- * _s Theme Customizer
+ * _s Theme Customizer.
*
* @package _s
*/
View
@@ -1,8 +1,8 @@
<?php
/**
- * Custom functions that act independently of the theme templates
+ * Custom functions that act independently of the theme templates.
*
- * Eventually, some of the functionality here could be replaced by core features
+ * Eventually, some of the functionality here could be replaced by core features.
*
* @package _s
*/
View
@@ -1,7 +1,8 @@
<?php
/**
- * Jetpack Compatibility File
- * See: https://jetpack.me/
+ * Jetpack Compatibility File.
+ *
+ * @link https://jetpack.me/
*
* @package _s
*/
View
@@ -6,7 +6,8 @@
* 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
+ *
+ * @link https://codex.wordpress.org/Template_Hierarchy
*
* @package _s
*/
View
@@ -1,4 +1,6 @@
/**
+ * customizer.js
+ *
* Theme Customizer enhancements for a better user experience.
*
* Contains handlers to make Theme Customizer preview reload changes asynchronously.
@@ -1,3 +1,10 @@
+/**
+ * skip-link-focus-fix.js
+ *
+ * Helps with accesability for keyboard only users.
+ *
+ * Learn more: https://github.com/Automattic/_s/pull/136
+ */
( function() {
var is_webkit = navigator.userAgent.toLowerCase().indexOf( 'webkit' ) > -1,
is_opera = navigator.userAgent.toLowerCase().indexOf( 'opera' ) > -1,
@@ -1,6 +1,9 @@
/*
-Theme Name: _s
-Layout: Content-Sidebar
+ * Theme Name: _s
+ *
+ * Layout: Content-Sidebar
+ *
+ * Learn more: https://developer.wordpress.org/themes/basics/template-files/
*/
.content-area {
@@ -1,6 +1,9 @@
/*
-Theme Name: _s
-Layout: Sidebar-Content
+ * Theme Name: _s
+ *
+ * Layout: Sidebar-Content
+ *
+ * Learn more: https://developer.wordpress.org/themes/basics/template-files/
*/
.content-area {
View
@@ -4,9 +4,11 @@
*
* 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
+ * and that other 'pages' on your WordPress site may use a
* different template.
*
+ * @link https://codex.wordpress.org/Template_Hierarchy
+ *
* @package _s
*/
View
@@ -2,6 +2,8 @@
/**
* The template for displaying search results pages.
*
+ * @link https://developer.wordpress.org/themes/basics/template-hierarchy/#search-result
+ *
* @package _s
*/
View
@@ -2,6 +2,8 @@
/**
* The sidebar containing the main widget area.
*
+ * @link https://developer.wordpress.org/themes/basics/template-files/#template-partials
+ *
* @package _s
*/
View
@@ -2,6 +2,8 @@
/**
* The template for displaying all single posts.
*
+ * @link https://developer.wordpress.org/themes/basics/template-hierarchy/#single-post
+ *
* @package _s
*/
@@ -1,8 +1,8 @@
<?php
/**
- * The template part for displaying a message that posts cannot be found.
+ * Template part for displaying a message that posts cannot be found.
*
- * Learn more: http://codex.wordpress.org/Template_Hierarchy
+ * @link https://codex.wordpress.org/Template_Hierarchy
*
* @package _s
*/
@@ -1,6 +1,8 @@
<?php
/**
- * The template used for displaying page content in page.php
+ * Template part for displaying page content in page.php.
+ *
+ * @link https://codex.wordpress.org/Template_Hierarchy
*
* @package _s
*/
@@ -1,8 +1,8 @@
<?php
/**
- * The template part for displaying results in search pages.
+ * Template part for displaying results in search pages.
*
- * Learn more: http://codex.wordpress.org/Template_Hierarchy
+ * @link https://codex.wordpress.org/Template_Hierarchy
*
* @package _s
*/
@@ -2,6 +2,8 @@
/**
* Template part for displaying single posts.
*
+ * @link https://codex.wordpress.org/Template_Hierarchy
+ *
* @package _s
*/
@@ -2,6 +2,8 @@
/**
* Template part for displaying posts.
*
+ * @link https://codex.wordpress.org/Template_Hierarchy
+ *
* @package _s
*/

0 comments on commit de9c988

Please sign in to comment.