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 code comments

Browse source 
Making sure that the code comments strictly follow that of the WordPress PHP Documentation Standards
This commit is contained in:
Tom McFarlin 2014-07-29 15:56:12 -04:00
parent 2a66ff4d50
commit 2af01cf653
2 changed files with 22 additions and 20 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,22 +1,23 @@
<?php <?php
/** /**
* Define a short description for what this class does (no period) * Short Description (no period)
*
* Long Description.
*
* @link http://example.com/
* @since 1.0.0
* *
* @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
*/ */
/** /**
* Define a short description for what this class does. * Short Description. (use period)
* *
* Define a longer description for the purpose of this class. * Long Description.
* *
* @since 1.0.0
* @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>
@ -24,9 +25,9 @@
class Plugin_Name_Activator { class Plugin_Name_Activator {
/** /**
* Short description. (use period) * Short Description. (use period)
* *
* Long description. * Long Description.
* *
* @since 1.0.0 * @since 1.0.0
*/ */

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

@ -1,22 +1,23 @@
<?php <?php
/** /**
* Define a short description for what this class does (no period) * Short Description (no period)
*
* Long Description.
*
* @link http://example.com/
* @since 1.0.0
* *
* @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
*/ */
/** /**
* Define a short description for what this class does. * Short Description. (use period)
* *
* Define a longer description for the purpose of this class. * Long Description.
* *
* @since 1.0.0
* @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>
@ -24,9 +25,9 @@
class Plugin_Name_Deactivator { class Plugin_Name_Deactivator {
/** /**
* Short description. (use period) * Short Description. (use period)
* *
* Long description. * Long Description.
* *
* @since 1.0.0 * @since 1.0.0
*/ */