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

adding docblocks consistent with the wpcs for the files in includes

Browse source 
http://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/
Signed-off-by: Tom McFarlin <tom@tommcfarlin.com>
This commit is contained in:
Tom McFarlin 2014-04-25 18:58:07 -04:00
parent 2cf4ba8223
commit 026515da85
3 changed files with 27 additions and 28 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

@ -7,27 +7,24 @@
* *
* @package Plugin_Name * @package Plugin_Name
* @author Your Name <email@example.com> * @author Your Name <email@example.com>
* @license GPL-2.0+
* @link http://example.com
* @copyright 2014 Your Name or Company Name
*/ */
class Plugin_Name_Activator { class Plugin_Name_Activator {
/** /**
* TODO: Short description. (use period) * Short description. (use period)
* *
* TODO: Long description. * Long description.
* *
* @since x.x.x * @since x.x.x
* @access (for functions: only use if private)
*
* @see Function/method/class relied on
* @link URL
* @global type $varname Short description.
* *
* @param type $var Description. * @param type $var Description.
* @param array $args { * @param type $var Optional. Description.
* Short description about this hash. * @return type Description.
*
* @type type $var Description.
* @type type $var Description.
* }
* @param type $var Description.
*/ */
public static function activate() { public static function activate() {

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

@ -1,15 +1,15 @@
<?php <?php
/** /**
* TODO: Short description (no period for file headers) * Short Description (no period for file headers)
* *
* TODO: Long description. * Long Description.
* *
* @package Plugin_Name * @link URL
* @author Your Name <email@example.com> * @since x.x.x (if available)
* @license GPL-2.0+ *
* @link http://example.com * @package WordPress
* @copyright 2014 Your Name or Company Name * @subpackage Component
*/ */
class Plugin_Name_Deactivator { class Plugin_Name_Deactivator {

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

@ -1,14 +1,16 @@
<?php <?php
/**
* @TEAM http://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/#1-functions-and-class-methods
*
* @package Plugin_Name
* @author Your Name <email@example.com>
* @license GPL-2.0+
* @link http://example.com
* @copyright 2014 Your Name or Company Name
*/
/**
* Short Description (no period for file headers)
*
* Long Description.
*
* @link URL
* @since x.x.x (if available)
*
* @package WordPress
* @subpackage Component
*/
class Plugin_Name { class Plugin_Name {
} }