rayelliott
/
_s
Archived
forked from mirror/_s
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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.
This commit is contained in:
PJ 2015-07-01 11:21:44 -04:00
parent 5bb0534358
commit de9c9888b7
24 changed files with 65 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
404.php
View File

@ -2,6 +2,8 @@
/** /**
* The template for displaying 404 pages (not found). * The template for displaying 404 pages (not found).
* *
* @link https://codex.wordpress.org/Creating_an_Error_404_Page
*
* @package _s * @package _s
*/ */

2
archive.php
View File

@ -2,7 +2,7 @@
/** /**
* The template for displaying archive pages. * The template for displaying archive pages.
* *
* Learn more: http://codex.wordpress.org/Template_Hierarchy * @link https://codex.wordpress.org/Template_Hierarchy
* *
* @package _s * @package _s
*/ */

4
comments.php
View File

@ -2,9 +2,11 @@
/** /**
* The template for displaying comments. * 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. * and the comment form.
* *
* @link https://codex.wordpress.org/Template_Hierarchy
*
* @package _s * @package _s
*/ */

4
footer.php
View File

@ -2,7 +2,9 @@
/** /**
* The template for displaying the footer. * 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 * @package _s
*/ */

4
functions.php
View File

@ -1,6 +1,8 @@
<?php <?php
/** /**
* _s functions and definitions * _s functions and definitions.
*
* @link https://codex.wordpress.org/Functions_File_Explained
* *
* @package _s * @package _s
*/ */

4
header.php
View File

@ -2,7 +2,9 @@
/** /**
* The header for our theme. * 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 * @package _s
*/ */

5
inc/custom-header.php
View File

@ -1,7 +1,6 @@
<?php <?php
/** /**
* Sample implementation of the Custom Header feature * Sample implementation of the Custom Header feature.
* http://codex.wordpress.org/Custom_Headers
* *
* You can add an optional custom header image to header.php like so ... * You can add an optional custom header image to header.php like so ...
* *
@ -11,6 +10,8 @@
</a> </a>
<?php endif; // End header image check. ?> <?php endif; // End header image check. ?>
* *
* @link http://codex.wordpress.org/Custom_Headers
*
* @package _s * @package _s
*/ */

2
inc/customizer.php
View File

@ -1,6 +1,6 @@
<?php <?php
/** /**
* _s Theme Customizer * _s Theme Customizer.
* *
* @package _s * @package _s
*/ */

4
inc/extras.php
View File

@ -1,8 +1,8 @@
<?php <?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 * @package _s
*/ */

5
inc/jetpack.php
View File

@ -1,7 +1,8 @@
<?php <?php
/** /**
* Jetpack Compatibility File * Jetpack Compatibility File.
* See: https://jetpack.me/ *
* @link https://jetpack.me/
* *
* @package _s * @package _s
*/ */

3
index.php
View File

@ -6,7 +6,8 @@
* and one of the two required files for a theme (the other being style.css). * 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. * 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. * 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 * @package _s
*/ */

2
js/customizer.js
View File

@ -1,4 +1,6 @@
/** /**
* customizer.js
*
* Theme Customizer enhancements for a better user experience. * Theme Customizer enhancements for a better user experience.
* *
* Contains handlers to make Theme Customizer preview reload changes asynchronously. * Contains handlers to make Theme Customizer preview reload changes asynchronously.

7
js/skip-link-focus-fix.js
View File

@ -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() { ( function() {
var is_webkit = navigator.userAgent.toLowerCase().indexOf( 'webkit' ) > -1, var is_webkit = navigator.userAgent.toLowerCase().indexOf( 'webkit' ) > -1,
is_opera = navigator.userAgent.toLowerCase().indexOf( 'opera' ) > -1, is_opera = navigator.userAgent.toLowerCase().indexOf( 'opera' ) > -1,

7
layouts/content-sidebar.css
View File

@ -1,6 +1,9 @@
/* /*
Theme Name: _s * Theme Name: _s
Layout: Content-Sidebar *
* Layout: Content-Sidebar
*
* Learn more: https://developer.wordpress.org/themes/basics/template-files/
*/ */
.content-area { .content-area {

7
layouts/sidebar-content.css
View File

@ -1,6 +1,9 @@
/* /*
Theme Name: _s * Theme Name: _s
Layout: Sidebar-Content *
* Layout: Sidebar-Content
*
* Learn more: https://developer.wordpress.org/themes/basics/template-files/
*/ */
.content-area { .content-area {

4
page.php
View File

@ -4,9 +4,11 @@
* *
* This is the template that displays all pages by default. * This is the template that displays all pages by default.
* Please note that this is the WordPress construct of pages * 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. * different template.
* *
* @link https://codex.wordpress.org/Template_Hierarchy
*
* @package _s * @package _s
*/ */

2
search.php
View File

@ -2,6 +2,8 @@
/** /**
* The template for displaying search results pages. * The template for displaying search results pages.
* *
* @link https://developer.wordpress.org/themes/basics/template-hierarchy/#search-result
*
* @package _s * @package _s
*/ */

2
sidebar.php
View File

@ -2,6 +2,8 @@
/** /**
* The sidebar containing the main widget area. * The sidebar containing the main widget area.
* *
* @link https://developer.wordpress.org/themes/basics/template-files/#template-partials
*
* @package _s * @package _s
*/ */

2
single.php
View File

@ -2,6 +2,8 @@
/** /**
* The template for displaying all single posts. * The template for displaying all single posts.
* *
* @link https://developer.wordpress.org/themes/basics/template-hierarchy/#single-post
*
* @package _s * @package _s
*/ */

4
template-parts/content-none.php
View File

@ -1,8 +1,8 @@
<?php <?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 * @package _s
*/ */

4
template-parts/content-page.php
View File

@ -1,6 +1,8 @@
<?php <?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 * @package _s
*/ */

4
template-parts/content-search.php
View File

@ -1,8 +1,8 @@
<?php <?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 * @package _s
*/ */

2
template-parts/content-single.php
View File

@ -2,6 +2,8 @@
/** /**
* Template part for displaying single posts. * Template part for displaying single posts.
* *
* @link https://codex.wordpress.org/Template_Hierarchy
*
* @package _s * @package _s
*/ */

2
template-parts/content.php
View File

@ -2,6 +2,8 @@
/** /**
* Template part for displaying posts. * Template part for displaying posts.
* *
* @link https://codex.wordpress.org/Template_Hierarchy
*
* @package _s * @package _s
*/ */