Changeset 25521 for trunk/src/wp-content/themes/twentytwelve/functions.php

Timestamp:

09/20/2013 07:23:22 PM (13 years ago)

Author:

lancewillett

Message:

Twenty Twelve: update code comments to reflect WP inline docs standards. Props DrewAPicture, see #25256.

File:

• trunk/src/wp-content/themes/twentytwelve/functions.php (modified) (24 diffs)

trunk/src/wp-content/themes/twentytwelve/functions.php

@@ -1 +1 @@
 <?php
 /**
- * Twenty Twelve functions and definitions.
+ * Twenty Twelve functions and definitions
  *
  * Sets up the theme and provides some helper functions, which are used
@@ -16 +16 @@
  * to a filter or action hook.
  *
- * For more information on hooks, actions, and filters, see http://codex.wordpress.org/Plugin_API.
+ * For more information on hooks, actions, and filters, @link http://codex.wordpress.org/Plugin_API
  *
  * @package WordPress
@@ -24 +24 @@
 
 /**
- * Sets up the content width value based on the theme's design and stylesheet.
+ * Set up the content width value based on the theme's design and stylesheet.
  */
 if ( ! isset( $content_width ) )
@@ -30 +30 @@
 
 /**
+ * Twenty Twelve setup.
+ *
  * Sets up theme defaults and registers the various WordPress features that
  * Twenty Twelve supports.
@@ -43 +45 @@
  */
 function twentytwelve_setup() {
-        /*
+        /**
          * Makes Twenty Twelve available for translation.
          *
@@ -64 +66 @@
         register_nav_menu( 'primary', __( 'Primary Menu', 'twentytwelve' ) );
 
-        /*
-         * This theme supports custom background color and image, and here
-         * we also set up the default background color.
+        /**
+         * This theme supports custom background color and image,
+         * and here we also set up the default background color.
          */
         add_theme_support( 'custom-background', array(
@@ -79 +81 @@
 
 /**
- * Adds support for a custom header image.
+ * Add support for a custom header image.
  */
 require( get_template_directory() . '/inc/custom-header.php' );
 
 /**
- * Returns the Google font stylesheet URL if available.
+ * Return the Google font stylesheet URL if available.
  *
  * The use of Open Sans by default is localized. For languages that use
@@ -96 +98 @@
         $font_url = '';
 
-        /* translators: If there are characters in your language that are not supported
-         by Open Sans, translate this to 'off'. Do not translate into your own language. */
+        /**
+         * translators: If there are characters in your language that are not supported
+         * by Open Sans, translate this to 'off'. Do not translate into your own language.
+         */
         if ( 'off' !== _x( 'on', 'Open Sans font: on or off', 'twentytwelve' ) ) {
                 $subsets = 'latin,latin-ext';
 
-                /* translators: To add an additional Open Sans character subset specific to your language, translate
-                 this to 'greek', 'cyrillic' or 'vietnamese'. Do not translate into your own language. */
+                /**
+                 * translators: To add an additional Open Sans character subset specific to your language,
+                 * translate this to 'greek', 'cyrillic' or 'vietnamese'. Do not translate into your own language.
+                 */
                 $subset = _x( 'no-subset', 'Open Sans font: add new subset (greek, cyrillic, vietnamese)', 'twentytwelve' );
 
@@ -124 +130 @@
 
 /**
- * Enqueues scripts and styles for front-end.
- *
- * @since Twenty Twelve 1.0
+ * Enqueue scripts and styles for front-end.
+ *
+ * @since Twenty Twelve 1.0
+ *
+ * @return void
  */
 function twentytwelve_scripts_styles() {
         global $wp_styles;
 
-        /*
+        /**
          * Adds JavaScript to pages with the comment form to support
          * sites with threaded comments (when in use).
@@ -138 +146 @@
                 wp_enqueue_script( 'comment-reply' );
 
-        /*
+        /**
          * Adds JavaScript for handling the navigation menu hide-and-show behavior.
          */
@@ -147 +155 @@
                 wp_enqueue_style( 'twentytwelve-fonts', esc_url_raw( $font_url ), array(), null );
 
-        /*
+        /**
          * Loads our main stylesheet.
          */
         wp_enqueue_style( 'twentytwelve-style', get_stylesheet_uri() );
 
-        /*
+        /**
          * Loads the Internet Explorer specific stylesheet.
          */
@@ -161 +169 @@
 
 /**
+ * Filter TinyMCE CSS path to include Google Fonts.
+ *
  * Adds additional stylesheets to the TinyMCE editor if needed.
  *
@@ -168 +178 @@
  *
  * @param string $mce_css CSS path to load in TinyMCE.
- * @return string
+ * @return string Filtered CSS path.
  */
 function twentytwelve_mce_css( $mce_css ) {
@@ -186 +196 @@
 
 /**
+ * Filter the page title.
+ *
  * Creates a nicely formatted and more specific title element text
  * for output in head of document, based on current view.
@@ -218 +230 @@
 
 /**
+ * Filter the page menu arguments.
+ *
  * Makes our wp_nav_menu() fallback -- wp_page_menu() -- show a home link.
  *
@@ -230 +244 @@
 
 /**
+ * Register sidebars.
+ *
  * Registers our main widget area and the front page widget areas.
  *
@@ -298 +314 @@
  *
  * @since Twenty Twelve 1.0
+ *
+ * @return void
  */
 function twentytwelve_comment( $comment, $args, $depth ) {
@@ -354 +372 @@
 if ( ! function_exists( 'twentytwelve_entry_meta' ) ) :
 /**
+ * Set up post entry meta.
+ *
  * Prints HTML with meta information for current post: categories, tags, permalink, author, and date.
  *
@@ -359 +379 @@
  *
  * @since Twenty Twelve 1.0
+ *
+ * @return void
  */
 function twentytwelve_entry_meta() {
@@ -400 +422 @@
 
 /**
+ * Extend the default WordPress body classes.
+ *
  * Extends the default WordPress body class to denote:
  * 1. Using a full-width layout, when no active widgets in the sidebar
@@ -411 +435 @@
  * @since Twenty Twelve 1.0
  *
- * @param array Existing class values.
+ * @param array $classes Existing class values.
  * @return array Filtered class values.
  */
@@ -448 +472 @@
 
 /**
+ * Adjust content width in certain contexts.
+ *
  * Adjusts content_width value for full-width and single image attachment
  * templates, and when there are no active widgets in the sidebar.
  *
  * @since Twenty Twelve 1.0
+ *
+ * @return void
  */
 function twentytwelve_content_width() {
@@ -462 +490 @@
 
 /**
- * Add postMessage support for site title and description for the Theme Customizer.
- *
- * @since Twenty Twelve 1.0
- *
- * @param WP_Customize_Manager $wp_customize Theme Customizer object.
+ * Register postMessage support.
+ *
+ * Add postMessage support for site title and description for the Customizer.
+ *
+ * @since Twenty Twelve 1.0
+ *
+ * @param WP_Customize_Manager $wp_customize Customizer object.
  * @return void
  */
@@ -477 +507 @@
 
 /**
- * Binds JS handlers to make Theme Customizer preview reload changes asynchronously.
- *
- * @since Twenty Twelve 1.0
+ * Enqueue Javascript postMessage handlers for the Customizer.
+ *
+ * Binds JS handlers to make the Customizer preview reload changes asynchronously.
+ *
+ * @since Twenty Twelve 1.0
+ *
+ * @return void
  */
 function twentytwelve_customize_preview_js() {