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

updating the docblocks

Browse source
This commit is contained in:
Tom McFarlin 2014-05-03 15:28:04 -04:00
parent ee79eb4582
commit c83aa5434d
3 changed files with 40 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
plugin-name/trunk/includes/class-plugin-name-activator.php
View file

@ -1,12 +1,15 @@
<?php <?php
/** /**
* Short description (no period for file headers) * Define a short description for what this class does (no period)
*
* Long description.
* *
* @package Plugin_Name * @package Plugin_Name
* @subpackage Plugin_name/includes * @subpackage Plugin_Name/includes
* @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
*/ */
/** /**
@ -14,10 +17,9 @@
* *
* Define a longer description for the purpose of this class. * Define a longer description for the purpose of this class.
* *
* @author Your Name <email@example.com> * @package Plugin_Name
* @license GPL-2.0+ * @subpackage Plugin_Name/includes
* @link http://example.com * @author Your Name <email@example.com>
* @copyright 2014 Your Name or Company Name
*/ */
class Plugin_Name_Activator { class Plugin_Name_Activator {
@ -26,8 +28,7 @@ class Plugin_Name_Activator {
* *
* Long description. * Long description.
* *
* @since x.x.x * @since 1.0.0
* @link URL
*/ */
public static function activate() { public static function activate() {

19
plugin-name/trunk/includes/class-plugin-name-deactivator.php
View file

@ -1,12 +1,15 @@
<?php <?php
/** /**
* Short description (no period for file headers) * Define a short description for what this class does (no period)
*
* Long description.
* *
* @package Plugin_Name * @package Plugin_Name
* @subpackage Plugin_name/includes * @subpackage Plugin_Name/includes
* @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
*/ */
/** /**
@ -14,10 +17,9 @@
* *
* Define a longer description for the purpose of this class. * Define a longer description for the purpose of this class.
* *
* @author Your Name <email@example.com> * @package Plugin_Name
* @license GPL-2.0+ * @subpackage Plugin_Name/includes
* @link http://example.com * @author Your Name <email@example.com>
* @copyright 2014 Your Name or Company Name
*/ */
class Plugin_Name_Deactivator { class Plugin_Name_Deactivator {
@ -26,6 +28,7 @@ class Plugin_Name_Deactivator {
* *
* Long description. * Long description.
* *
* @since 1.0.0
*/ */
public static function deactivate() { public static function deactivate() {

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

@ -1,36 +1,38 @@
<?php <?php
/** /**
* Short description (no period for file headers) * Define a short description for what this class does (no period)
* *
* Long description. * @package Plugin_Name
* @subpackage Plugin_Name/includes
* @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
*/
/**
* Define a short description for what this class does.
*
* Define a longer description for the purpose of this class.
* *
* @package Plugin_Name * @package Plugin_Name
* @subpackage Plugin_Name/includes * @subpackage Plugin_Name/includes
* @author Your Name <email@example.com> * @author Your Name <email@example.com>
*/ */
/**
* Short description (no period for file headers)
*
* Long description.
*
* @author Your Name <email@example.com>
* @license GPL-2.0+
* @link http://example.com
* @copyright 2014 Your Name or Company Name
*/
class Plugin_Name { class Plugin_Name {
/** /**
* This class is used to define common functionality that exists between * This class is used to define common functionality that exists between
* both the dashboard and the public-facing side of the website. * both the dashboard and the public-facing side of the website. Think
* of this as a shared class.
* *
* If any hooks are defined in this class, then they should be defined * If any hooks are defined in this class, then they should be defined
* in their respective Loader classes (that is, Plugin_Name_Admin_Loader * in their respective Loader classes (that is, Plugin_Name_Admin_Loader
* or Plugin_Name_Loader). * or Plugin_Name_Public_Loader).
* *
* An instance of this class should then be passed to the loader * An instance of this class should then be passed to the loader.
*/ */
} }