1
0
Fork 0
mirror of https://github.com/inretio/WordPress-Plugin-Boilerplate synced 2024-12-22 20:03:53 +02:00

updating the docblocks and adding whitespace to the end of the file

This commit is contained in:
Tom McFarlin 2014-05-03 15:06:38 -04:00
parent 4f2719b2eb
commit c10b371d67
3 changed files with 35 additions and 34 deletions

View file

@ -1,10 +1,15 @@
<?php <?php
/** /**
* Define a short description for what this class does. * Define a short description for what this class does (no period)
* *
* @since x.x.x * @package Plugin_Name
* @package TODO * @subpackage Plugin_Name/admin
* @author Your Name <email@example.com>
* @license GPL-2.0+
* @link http://example.com
* @copyright 2014 Your Name or Company Name
* @since 1.0.0
*/ */
/** /**
@ -12,11 +17,9 @@
* *
* Define a longer description for the purpose of this class. * Define a longer description for the purpose of this class.
* *
* @package TODO * @package Plugin_Name
* @author Your Name <your@email.com> * @subpackage Plugin_Name/admin
* @license GPL-2.0+ * @author Your Name <email@example.com>
* @link URL
* @copyright 2014 Your Name of Your Company Name
*/ */
class Plugin_Name_Admin_Loader { class Plugin_Name_Admin_Loader {
@ -26,8 +29,7 @@ class Plugin_Name_Admin_Loader {
* Long description. * Long description.
* *
* @since 1.0.0 * @since 1.0.0
* @link URL * @param type $plugin_name_admin A reference to the Plugin_Name_Admin class that defines the functions for the hooks.
* @param type $plugin_name_admin TODO
*/ */
public function run( $plugin_name_admin ) { public function run( $plugin_name_admin ) {
@ -38,11 +40,6 @@ class Plugin_Name_Admin_Loader {
* *
* Each hook then corresponds to a public function defined within the Plugin_Name_Admin * Each hook then corresponds to a public function defined within the Plugin_Name_Admin
* class. * class.
*
* For example:
*
* add_action( 'save_post' array( $plugin_name_admin, 'save_post' ) );
* add_filter( 'the_content', array( $plugin_name_admin, 'update_the_content' ) );
*/ */
add_action( 'admin_enqueue_scripts', array( $plugin_name_admin, 'enqueue_styles' ) ); add_action( 'admin_enqueue_scripts', array( $plugin_name_admin, 'enqueue_styles' ) );

View file

@ -1,10 +1,15 @@
<?php <?php
/** /**
* Define a short description for what this class does. * Define a short description for what this class does (no period)
* *
* @since x.x.x * @package Plugin_Name
* @package TODO * @subpackage Plugin_Name/admin
* @author Your Name <email@example.com>
* @license GPL-2.0+
* @link http://example.com
* @copyright 2014 Your Name or Company Name
* @since 1.0.0
*/ */
/** /**
@ -12,11 +17,9 @@
* *
* Define a longer description for the purpose of this class. * Define a longer description for the purpose of this class.
* *
* @package TODO * @package Plugin_Name
* @author Your Name <your@email.com> * @subpackage Plugin_Name/admin
* @license GPL-2.0+ * @author Your Name <email@example.com>
* @link URL
* @copyright 2014 Your Name of Your Company Name
*/ */
class Plugin_Name_Admin { class Plugin_Name_Admin {
@ -26,7 +29,6 @@ class Plugin_Name_Admin {
* Long description. * Long description.
* *
* @since 1.0.0 * @since 1.0.0
* @link URL
*/ */
public function enqueue_styles() { public function enqueue_styles() {
@ -52,7 +54,6 @@ class Plugin_Name_Admin {
* Long description. * Long description.
* *
* @since 1.0.0 * @since 1.0.0
* @link URL
*/ */
public function enqueue_scripts() { public function enqueue_scripts() {

View file

@ -1,10 +1,15 @@
<?php <?php
/** /**
* Define a short description for what this file does. * Define a short description for what this file does (no period)
* *
* @since x.x.x * @package Plugin_Name
* @package TODO * @subpackage Plugin_Name/admin/partials
* @author Your Name <email@example.com>
* @license GPL-2.0+
* @link http://example.com
* @copyright 2014 Your Name or Company Name
* @since 1.0.0
*/ */
/** /**
@ -12,11 +17,9 @@
* *
* Define a longer description for the purpose of this file. * Define a longer description for the purpose of this file.
* *
* @package TODO * @package Plugin_Name
* @author Your Name <your@email.com> * @subpackage Plugin_Name/admin/partials
* @license GPL-2.0+ * @author Your Name <email@example.com>
* @link URL
* @copyright 2014 Your Name of Your Company Name
*/ */
?> ?>