From de9c9888b7bf0e5fd60dd000e7efd579920d3d45 Mon Sep 17 00:00:00 2001 From: PJ Date: Wed, 1 Jul 2015 11:21:44 -0400 Subject: [PATCH] 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. --- 404.php | 2 ++ archive.php | 2 +- comments.php | 4 +++- footer.php | 4 +++- functions.php | 4 +++- header.php | 4 +++- inc/custom-header.php | 5 +++-- inc/customizer.php | 2 +- inc/extras.php | 4 ++-- inc/jetpack.php | 5 +++-- index.php | 3 ++- js/customizer.js | 2 ++ js/skip-link-focus-fix.js | 7 +++++++ layouts/content-sidebar.css | 7 +++++-- layouts/sidebar-content.css | 7 +++++-- page.php | 4 +++- search.php | 2 ++ sidebar.php | 2 ++ single.php | 2 ++ template-parts/content-none.php | 4 ++-- template-parts/content-page.php | 4 +++- template-parts/content-search.php | 4 ++-- template-parts/content-single.php | 2 ++ template-parts/content.php | 2 ++ 24 files changed, 65 insertions(+), 23 deletions(-) diff --git a/404.php b/404.php index a77b457b..0938afa9 100644 --- a/404.php +++ b/404.php @@ -2,6 +2,8 @@ /** * The template for displaying 404 pages (not found). * + * @link https://codex.wordpress.org/Creating_an_Error_404_Page + * * @package _s */ diff --git a/archive.php b/archive.php index 0e123599..9e9d754b 100644 --- a/archive.php +++ b/archive.php @@ -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 */ diff --git a/comments.php b/comments.php index ab1fd3c3..7a3349bd 100644 --- a/comments.php +++ b/comments.php @@ -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 */ diff --git a/footer.php b/footer.php index 4a04b1bd..d51b251a 100644 --- a/footer.php +++ b/footer.php @@ -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 */ diff --git a/functions.php b/functions.php index 61bc7a16..cb437fa9 100644 --- a/functions.php +++ b/functions.php @@ -1,6 +1,8 @@ section and everything up till
+ * This is the template that displays all of the section and everything up until
+ * + * @link https://developer.wordpress.org/themes/basics/template-files/#template-partials * * @package _s */ diff --git a/inc/custom-header.php b/inc/custom-header.php index eba24410..9c17195a 100644 --- a/inc/custom-header.php +++ b/inc/custom-header.php @@ -1,7 +1,6 @@ * + * @link http://codex.wordpress.org/Custom_Headers + * * @package _s */ diff --git a/inc/customizer.php b/inc/customizer.php index e704cf58..3f531c54 100644 --- a/inc/customizer.php +++ b/inc/customizer.php @@ -1,6 +1,6 @@ -1, is_opera = navigator.userAgent.toLowerCase().indexOf( 'opera' ) > -1, diff --git a/layouts/content-sidebar.css b/layouts/content-sidebar.css index 5e0951cd..8505da68 100644 --- a/layouts/content-sidebar.css +++ b/layouts/content-sidebar.css @@ -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 { diff --git a/layouts/sidebar-content.css b/layouts/sidebar-content.css index 6f0a119c..41f738c4 100644 --- a/layouts/sidebar-content.css +++ b/layouts/sidebar-content.css @@ -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 { diff --git a/page.php b/page.php index 3bbeac2a..d296c27a 100644 --- a/page.php +++ b/page.php @@ -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 */ diff --git a/search.php b/search.php index 6f2666fc..80dff64b 100644 --- a/search.php +++ b/search.php @@ -2,6 +2,8 @@ /** * The template for displaying search results pages. * + * @link https://developer.wordpress.org/themes/basics/template-hierarchy/#search-result + * * @package _s */ diff --git a/sidebar.php b/sidebar.php index ce8ea53f..b3a1f8c0 100644 --- a/sidebar.php +++ b/sidebar.php @@ -2,6 +2,8 @@ /** * The sidebar containing the main widget area. * + * @link https://developer.wordpress.org/themes/basics/template-files/#template-partials + * * @package _s */ diff --git a/single.php b/single.php index 7f256a31..55ae7394 100644 --- a/single.php +++ b/single.php @@ -2,6 +2,8 @@ /** * The template for displaying all single posts. * + * @link https://developer.wordpress.org/themes/basics/template-hierarchy/#single-post + * * @package _s */ diff --git a/template-parts/content-none.php b/template-parts/content-none.php index 8b6e010d..7ce861d5 100644 --- a/template-parts/content-none.php +++ b/template-parts/content-none.php @@ -1,8 +1,8 @@