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

Improving docblocks

Browse source 
* Documenting the plugin file
* Changing the docblock to read 'class', not 'file'

Related #199
This commit is contained in:
Tom McFarlin 2014-08-01 16:47:08 -04:00
parent 6d6f6399f7
commit f3133d8cb5
2 changed files with 12 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
plugin-name/trunk/includes/class-plugin-name.php
View file

@ -1,10 +1,10 @@
<?php <?php
/** /**
* The core plugin file * The core plugin class
* *
* This is the core plugin file that is used to define internationalization, * This is used to define internationalization, dashboard-specific hooks, and
* dashboard-specific hooks, and public-facing site hooks. * public-facing site hooks.
* *
* Also maintains the unique identifier of this plugin as well as the current * Also maintains the unique identifier of this plugin as well as the current
* version of the plugin. * version of the plugin.
@ -17,10 +17,10 @@
*/ */
/** /**
* The core plugin file. * The core plugin class
* *
* This is the core plugin file that is used to define internationalization, * This is used to define internationalization, dashboard-specific hooks, and
* dashboard-specific hooks, and public-facing site hooks. * public-facing site hooks.
* *
* Also maintains the unique identifier of this plugin as well as the current * Also maintains the unique identifier of this plugin as well as the current
* version of the plugin. * version of the plugin.

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

@ -1,10 +1,12 @@
<?php <?php
/** /**
/** * The plugin bootstrap file
* Short Description (no period for file headers)
* *
* Long Description. * This file is read my WordPress to generate the plugin information in the plugin
* Dashboard. This file also includes all of the dependencies used by the plugin,
* registers the activation and deactivation functions, and defines a function
* this starts the plugin.
* *
* @link URL * @link URL
* @since 1.0.0 * @since 1.0.0
@ -45,7 +47,7 @@ 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' ) );
/** /**
* This is the core plugin file that is used to define internationalization, * The core plugin class that is used to define internationalization,
* dashboard-specific hooks, and public-facing site hooks. * dashboard-specific hooks, and public-facing site hooks.
*/ */
require_once plugin_dir_path( __FILE__ ) . 'includes/class-plugin-name.php'; require_once plugin_dir_path( __FILE__ ) . 'includes/class-plugin-name.php';