inretio/WordPress-Plugin-Boilerplate
1
0
Fork 0
mirror of https://github.com/inretio/WordPress-Plugin-Boilerplate synced 2024-12-22 11:53:53 +02:00
Code Issues Releases Wiki Activity

finalizing docblocks

Browse source 
Making sure that the code comments strictly follow the WordPress PHP Documentation Standards
This commit is contained in:
Tom McFarlin 2014-07-29 15:48:33 -04:00
parent 3154e38822
commit 2a66ff4d50
1 changed files with 6 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
plugin-name/trunk/plugin-name.php
View file

@ -6,18 +6,14 @@
* Long Description. * Long Description.
* *
* @package Plugin_Name * @package Plugin_Name
* @author Your Name or Company Name <email@domain.com>
* @license GPL-2.0+
* @link http://example.com/plugin-name
* @copyright 2014 Your Name or Company Name
* *
* @wordpress-plugin * @wordpress-plugin
* Plugin Name: WordPress Plugin Boilerplate * Plugin Name: WordPress Plugin Boilerplate
* Plugin URI: http://example.com/plugin-name-uri * Plugin URI: http://example.com/plugin-name-uri/
* Description: This is a short description of what the plugin does. It's displayed in the WordPress dashboard. * Description: This is a short description of what the plugin does. It's displayed in the WordPress dashboard.
* Version: 1.0.0 * Version: 1.0.0
* Author: Your Name or Your Company * Author: Your Name or Your Company
* Author URI: http://example.com * Author URI: http://example.com/
* Text Domain: plugin-name-locale * Text Domain: plugin-name-locale
* License: GPL-2.0+ * License: GPL-2.0+
* License URI: http://www.gnu.org/licenses/gpl-2.0.txt * License URI: http://www.gnu.org/licenses/gpl-2.0.txt
@ -30,12 +26,12 @@ if ( ! defined( 'WPINC' ) ) {
} }
/** /**
* The plugin activation class that runs during plugin activation. * The code that runs during plugin activation.
*/ */
require_once plugin_dir_path( __FILE__ ) . 'includes/class-plugin-name-activator.php'; require_once plugin_dir_path( __FILE__ ) . 'includes/class-plugin-name-activator.php';
/** /**
* The plugin deactivation class that runs during plugin deactivation. * The code that runs during plugin deactivation.
*/ */
require_once plugin_dir_path( __FILE__ ) . 'includes/class-plugin-name-deactivator.php'; require_once plugin_dir_path( __FILE__ ) . 'includes/class-plugin-name-deactivator.php';
@ -46,8 +42,8 @@ register_activation_hook( __FILE__, array( 'Plugin_Name_Activator', 'activate' )
register_activation_hook( __FILE__, array( 'Plugin_Name_Deactivator', 'deactivate' ) ); register_activation_hook( __FILE__, array( 'Plugin_Name_Deactivator', 'deactivate' ) );
/** /**
* The base class used to define certain functionality and attributes used among * The base class used to define certain functionality and attributes used in both
* the dashboard-specific and public-facing functionality. * the the dashboard-specific and public-facing functionality.
*/ */
require_once plugin_dir_path( __FILE__ ) . 'includes/class-plugin-name.php'; require_once plugin_dir_path( __FILE__ ) . 'includes/class-plugin-name.php';