inretio/WordPress-Plugin-Boilerplate
1
0
Fork 0
mirror of https://github.com/inretio/WordPress-Plugin-Boilerplate synced 2025-05-04 12:59:07 +03: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
plugin-name/trunk/includes
class-plugin-name-activator.php

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

@ -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)
*
* @param type $var Description.
* @param array $args {
* Short description about this hash.
* @see Function/method/class relied on
* @link URL
* @global type $varname Short description.
*
* @type type $var Description.
* @type type $var Description.
* }
* @param type $var Description.
* @param type $var Description.
* @param type $var Optional. Description.
* @return type Description.
*/
public static function activate() {