From 13c4d67e4ff3deea3dbe66aeaea8f0875b8fec79 Mon Sep 17 00:00:00 2001 From: Robin Cornett Date: Sun, 3 Jul 2016 07:42:41 -0400 Subject: [PATCH] Update/add doc blocks --- display-featured-image-genesis.php | 6 +-- ...lass-displayfeaturedimagegenesis-admin.php | 2 +- ...ass-displayfeaturedimagegenesis-author.php | 2 +- ...ass-displayfeaturedimagegenesis-common.php | 4 +- ...displayfeaturedimagegenesis-customizer.php | 38 +++++++++---------- ...isplayfeaturedimagegenesis-description.php | 2 +- ...displayfeaturedimagegenesis-getsetting.php | 8 +++- ...ass-displayfeaturedimagegenesis-helper.php | 10 ++++- ...ass-displayfeaturedimagegenesis-output.php | 2 +- ...s-displayfeaturedimagegenesis-postmeta.php | 2 +- .../class-displayfeaturedimagegenesis-rss.php | 2 +- ...s-displayfeaturedimagegenesis-settings.php | 2 +- ...displayfeaturedimagegenesis-taxonomies.php | 2 +- ...playfeaturedimagegenesis-author-widget.php | 2 +- ...eaturedimagegenesis-cpt-archive-widget.php | 2 +- ...ayfeaturedimagegenesis-taxonomy-widget.php | 2 +- 16 files changed, 48 insertions(+), 40 deletions(-) diff --git a/display-featured-image-genesis.php b/display-featured-image-genesis.php index e57934f..e478f81 100644 --- a/display-featured-image-genesis.php +++ b/display-featured-image-genesis.php @@ -1,11 +1,11 @@ * @license GPL-2.0+ - * @link http://robincornett.com + * @link https://robincornett.com * @copyright 2014-2016 Robin Cornett Creative, LLC * * @wordpress-plugin @@ -14,7 +14,7 @@ * Description: This plugin works within the Genesis Framework, to display featured images in beautiful and dynamic ways. * Version: 2.5.1 * Author: Robin Cornett - * Author URI: http://robincornett.com + * Author URI: https://robincornett.com * Text Domain: display-featured-image-genesis * License: GPL-2.0+ * License URI: http://www.gnu.org/licenses/gpl-2.0.txt diff --git a/includes/class-displayfeaturedimagegenesis-admin.php b/includes/class-displayfeaturedimagegenesis-admin.php index 27ee064..e0232d7 100644 --- a/includes/class-displayfeaturedimagegenesis-admin.php +++ b/includes/class-displayfeaturedimagegenesis-admin.php @@ -6,7 +6,7 @@ * @package DisplayFeaturedImageGenesis * @author Robin Cornett * @license GPL-2.0+ - * @link http://robincornett.com + * @link https://robincornett.com * @copyright 2015-2016 Robin Cornett Creative, LLC * @since 2.0.0 */ diff --git a/includes/class-displayfeaturedimagegenesis-author.php b/includes/class-displayfeaturedimagegenesis-author.php index 7392cf1..5161b02 100644 --- a/includes/class-displayfeaturedimagegenesis-author.php +++ b/includes/class-displayfeaturedimagegenesis-author.php @@ -5,7 +5,7 @@ * @package DisplayFeaturedImageGenesis * @author Robin Cornett * @license GPL-2.0+ - * @link http://robincornett.com + * @link https://robincornett.com * @copyright 2014-2016 Robin Cornett Creative, LLC */ diff --git a/includes/class-displayfeaturedimagegenesis-common.php b/includes/class-displayfeaturedimagegenesis-common.php index 610d544..a3aa09a 100644 --- a/includes/class-displayfeaturedimagegenesis-common.php +++ b/includes/class-displayfeaturedimagegenesis-common.php @@ -7,7 +7,7 @@ * @package DisplayFeaturedImageGenesis * @author Robin Cornett * @license GPL-2.0+ - * @link http://robincornett.com + * @link https://robincornett.com * @copyright 2014-2016 Robin Cornett Creative, LLC * @since 1.2.1 */ @@ -18,7 +18,7 @@ class Display_Featured_Image_Genesis_Common { * @var string * @since 1.4.3 */ - public $version = '2.5.1'; + public $version = '2.6.0'; /** * set and retrieve variables for the featured image. diff --git a/includes/class-displayfeaturedimagegenesis-customizer.php b/includes/class-displayfeaturedimagegenesis-customizer.php index 3c75477..1f0b91d 100644 --- a/includes/class-displayfeaturedimagegenesis-customizer.php +++ b/includes/class-displayfeaturedimagegenesis-customizer.php @@ -30,6 +30,7 @@ class Display_Featured_Image_Genesis_Customizer extends Display_Featured_Image_G * Adds the individual sections, settings, and controls to the theme customizer * @param $wp_customize WP_Customize_Manager * @uses add_section() adds a section to the customizer + * @since 2.6.0 */ public function customizer( $wp_customize ) { @@ -53,6 +54,7 @@ class Display_Featured_Image_Genesis_Customizer extends Display_Featured_Image_G /** * Build the Display Featured Image for Genesis Customizer settings panel. * @param $wp_customize + * @since 2.6.0 */ protected function build_fields( $wp_customize ) { $numbers = $this->number_fields(); @@ -74,7 +76,9 @@ class Display_Featured_Image_Genesis_Customizer extends Display_Featured_Image_G } /** + * Define the number fields (height, max-height) for the customizer. * @return array + * @since 2.6.0 */ function number_fields() { return array( @@ -99,6 +103,11 @@ class Display_Featured_Image_Genesis_Customizer extends Display_Featured_Image_G ); } + /** + * Define all the checkbox fields for the customizer. + * @return array + * @since 2.6.0 + */ protected function checkbox_fields() { return array( array( @@ -129,6 +138,11 @@ class Display_Featured_Image_Genesis_Customizer extends Display_Featured_Image_G ); } + /** + * Define the control setting for the default image. + * @return array + * @since 2.6.0 + */ protected function default_image() { $common = new Display_Featured_Image_Genesis_Common(); $size = $common->minimum_backstretch_width(); @@ -142,27 +156,7 @@ class Display_Featured_Image_Genesis_Customizer extends Display_Featured_Image_G /** * @param $wp_customize WP_Customize_Manager * @param $setting - */ - protected function do_color_setting( $wp_customize, $setting ) { - - $this->add_setting( $wp_customize, $setting ); - $wp_customize->add_control( - new WP_Customize_Color_Control( - $wp_customize, - $this->section . '[' . $setting['setting'] . ']', - array( - 'description' => $setting['description'], - 'label' => $setting['label'], - 'section' => $this->section, - 'settings' => $this->section . '[' . $setting['setting'] . ']', - ) - ) - ); - } - - /** - * @param $wp_customize WP_Customize_Manager - * @param $setting + * @since 2.6.0 */ protected function do_image_setting( $wp_customize, $setting ) { $this->add_setting( $wp_customize, $setting ); @@ -183,6 +177,7 @@ class Display_Featured_Image_Genesis_Customizer extends Display_Featured_Image_G /** * @param $wp_customize WP_Customize_Manager * @param $setting + * @since 2.6.0 */ protected function add_control( $wp_customize, $setting ) { $this->add_setting( $wp_customize, $setting ); @@ -202,6 +197,7 @@ class Display_Featured_Image_Genesis_Customizer extends Display_Featured_Image_G /** * @param $wp_customize WP_Customize_Manager * @param $setting + * @since 2.6.0 */ protected function add_setting( $wp_customize, $setting ) { $wp_customize->add_setting( diff --git a/includes/class-displayfeaturedimagegenesis-description.php b/includes/class-displayfeaturedimagegenesis-description.php index 4681e43..a112f7b 100644 --- a/includes/class-displayfeaturedimagegenesis-description.php +++ b/includes/class-displayfeaturedimagegenesis-description.php @@ -3,7 +3,7 @@ * @package DisplayFeaturedImageGenesis * @author Robin Cornett * @license GPL-2.0+ - * @link http://robincornett.com + * @link https://robincornett.com * @copyright 2014-2016 Robin Cornett Creative, LLC */ diff --git a/includes/class-displayfeaturedimagegenesis-getsetting.php b/includes/class-displayfeaturedimagegenesis-getsetting.php index 36ec355..b511933 100644 --- a/includes/class-displayfeaturedimagegenesis-getsetting.php +++ b/includes/class-displayfeaturedimagegenesis-getsetting.php @@ -2,12 +2,16 @@ /** * Class DisplayFeaturedImageGenesisDoSetting - * @package DisplayFeaturedImageGenesis + * @package Display_Featured_Image_Genesis * @copyright 2016 Robin Cornett */ class DisplayFeaturedImageGenesisGetSetting { - + /** + * Define the default plugin settings. + * @return mixed|void + * @since 2.6.0 + */ public function defaults() { return apply_filters( 'displayfeaturedimagegenesis_defaults', array( 'less_header' => 0, diff --git a/includes/class-displayfeaturedimagegenesis-helper.php b/includes/class-displayfeaturedimagegenesis-helper.php index 428cad4..1dc4ba9 100644 --- a/includes/class-displayfeaturedimagegenesis-helper.php +++ b/includes/class-displayfeaturedimagegenesis-helper.php @@ -3,14 +3,22 @@ * @package DisplayFeaturedImageGenesis * @author Robin Cornett * @license GPL-2.0+ - * @link http://robincornett.com + * @link https://robincornett.com * @copyright 2014-2016 Robin Cornett Creative, LLC */ class Display_Featured_Image_Genesis_Helper extends DisplayFeaturedImageGenesisGetSetting { + /** + * Variable for the plugin setting. + * @var $setting + */ protected $setting; + /** + * Base id/slug for the settings page. + * @var string $page + */ protected $page = 'displayfeaturedimagegenesis'; /** diff --git a/includes/class-displayfeaturedimagegenesis-output.php b/includes/class-displayfeaturedimagegenesis-output.php index cbf325d..8fc5874 100644 --- a/includes/class-displayfeaturedimagegenesis-output.php +++ b/includes/class-displayfeaturedimagegenesis-output.php @@ -3,7 +3,7 @@ * @package DisplayFeaturedImageGenesis * @author Robin Cornett * @license GPL-2.0+ - * @link http://robincornett.com + * @link https://robincornett.com * @copyright 2014-2016 Robin Cornett Creative, LLC */ diff --git a/includes/class-displayfeaturedimagegenesis-postmeta.php b/includes/class-displayfeaturedimagegenesis-postmeta.php index 82ae905..881ecda 100644 --- a/includes/class-displayfeaturedimagegenesis-postmeta.php +++ b/includes/class-displayfeaturedimagegenesis-postmeta.php @@ -5,7 +5,7 @@ * @package DisplayFeaturedImageGenesis * @author Robin Cornett * @license GPL-2.0+ - * @link http://robincornett.com + * @link https://robincornett.com * @copyright 2014-2016 Robin Cornett Creative, LLC */ class Display_Featured_Image_Genesis_Post_Meta { diff --git a/includes/class-displayfeaturedimagegenesis-rss.php b/includes/class-displayfeaturedimagegenesis-rss.php index d2f6580..17657e3 100644 --- a/includes/class-displayfeaturedimagegenesis-rss.php +++ b/includes/class-displayfeaturedimagegenesis-rss.php @@ -3,7 +3,7 @@ * @package DisplayFeaturedImageGenesis * @author Robin Cornett * @license GPL-2.0+ - * @link http://robincornett.com + * @link https://robincornett.com * @copyright 2014-2016 Robin Cornett Creative, LLC */ diff --git a/includes/class-displayfeaturedimagegenesis-settings.php b/includes/class-displayfeaturedimagegenesis-settings.php index 5604b14..59db83b 100644 --- a/includes/class-displayfeaturedimagegenesis-settings.php +++ b/includes/class-displayfeaturedimagegenesis-settings.php @@ -3,7 +3,7 @@ * @package DisplayFeaturedImageGenesis * @author Robin Cornett * @license GPL-2.0+ - * @link http://robincornett.com + * @link https://robincornett.com * @copyright 2014-2016 Robin Cornett Creative, LLC */ diff --git a/includes/class-displayfeaturedimagegenesis-taxonomies.php b/includes/class-displayfeaturedimagegenesis-taxonomies.php index 6504805..34121e3 100644 --- a/includes/class-displayfeaturedimagegenesis-taxonomies.php +++ b/includes/class-displayfeaturedimagegenesis-taxonomies.php @@ -6,7 +6,7 @@ * @package DisplayFeaturedImageGenesis * @author Robin Cornett * @license GPL-2.0+ - * @link http://robincornett.com + * @link https://robincornett.com * @copyright 2014-2016 Robin Cornett Creative, LLC * * @since 2.0.0 diff --git a/includes/widgets/displayfeaturedimagegenesis-author-widget.php b/includes/widgets/displayfeaturedimagegenesis-author-widget.php index 7e617f8..0d22d66 100644 --- a/includes/widgets/displayfeaturedimagegenesis-author-widget.php +++ b/includes/widgets/displayfeaturedimagegenesis-author-widget.php @@ -5,7 +5,7 @@ * @package DisplayFeaturedImageGenesis * @author Robin Cornett * @license GPL-2.0+ - * @link http://robincornett.com + * @link https://robincornett.com * @copyright 2014-2016 Robin Cornett Creative, LLC */ diff --git a/includes/widgets/displayfeaturedimagegenesis-cpt-archive-widget.php b/includes/widgets/displayfeaturedimagegenesis-cpt-archive-widget.php index 8516180..6087c08 100644 --- a/includes/widgets/displayfeaturedimagegenesis-cpt-archive-widget.php +++ b/includes/widgets/displayfeaturedimagegenesis-cpt-archive-widget.php @@ -4,7 +4,7 @@ * * @package DisplayFeaturedImageGenesis * @author Robin Cornett - * @link http://robincornett.com + * @link https://robincornett.com * @copyright 2014-2016 Robin Cornett Creative, LLC * @license GPL-2.0+ * @since 2.0.0 diff --git a/includes/widgets/displayfeaturedimagegenesis-taxonomy-widget.php b/includes/widgets/displayfeaturedimagegenesis-taxonomy-widget.php index 1160193..558b63f 100644 --- a/includes/widgets/displayfeaturedimagegenesis-taxonomy-widget.php +++ b/includes/widgets/displayfeaturedimagegenesis-taxonomy-widget.php @@ -5,7 +5,7 @@ * @package DisplayFeaturedImageGenesis * @author Robin Cornett * @license GPL-2.0+ - * @link http://robincornett.com + * @link https://robincornett.com * @copyright 2014-2016 Robin Cornett Creative, LLC * @since 2.0.0 */