mirror of
https://github.com/inretio/WordPress-Plugin-Boilerplate
synced 2024-12-22 11:53:53 +02:00
adding docblocks consistent with the wpcs for the files in includes
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:
parent
2cf4ba8223
commit
026515da85
3 changed files with 27 additions and 28 deletions
|
@ -7,27 +7,24 @@
|
|||
*
|
||||
* @package Plugin_Name
|
||||
* @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 {
|
||||
|
||||
/**
|
||||
* TODO: Short description. (use period)
|
||||
* Short description. (use period)
|
||||
*
|
||||
* TODO: Long description.
|
||||
* Long description.
|
||||
*
|
||||
* @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 array $args {
|
||||
* Short description about this hash.
|
||||
*
|
||||
* @type type $var Description.
|
||||
* @type type $var Description.
|
||||
* }
|
||||
* @param type $var Description.
|
||||
* @param type $var Optional. Description.
|
||||
* @return type Description.
|
||||
*/
|
||||
public static function activate() {
|
||||
|
||||
|
|
|
@ -1,15 +1,15 @@
|
|||
<?php
|
||||
|
||||
/**
|
||||
* TODO: Short description (no period for file headers)
|
||||
* Short Description (no period for file headers)
|
||||
*
|
||||
* TODO: Long description.
|
||||
* Long Description.
|
||||
*
|
||||
* @package Plugin_Name
|
||||
* @author Your Name <email@example.com>
|
||||
* @license GPL-2.0+
|
||||
* @link http://example.com
|
||||
* @copyright 2014 Your Name or Company Name
|
||||
* @link URL
|
||||
* @since x.x.x (if available)
|
||||
*
|
||||
* @package WordPress
|
||||
* @subpackage Component
|
||||
*/
|
||||
class Plugin_Name_Deactivator {
|
||||
|
||||
|
|
|
@ -1,14 +1,16 @@
|
|||
<?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 {
|
||||
|
||||
}
|
||||
|
|
Loading…
Reference in a new issue