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

Completing the first round of docblocks for the activation / deactivation classes

Browse source
This commit is contained in:
Tom McFarlin 2014-04-30 22:32:27 -04:00
parent b7d17e4122
commit 5666bb7ddc
2 changed files with 42 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -1,30 +1,37 @@
<?php
/**
* TODO: Short description (no period for file headers)
* @TODO
* Short description (no period for file headers)
*
* TODO: Long description.
* Long description.
*
* @package Plugin_Name
* @package TODO
* @author Your Name <email@example.com>
*/
/**
* @TODO
* Short description (no period for file headers)
*
* Long description.
*
* @package TODO
* @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)
*
* 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 type $var Optional. Description.
* @return type Description.
* @since x.x.x
* @link URL
*/
public static function activate() {

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

@ -1,33 +1,37 @@
<?php
/**
* Short Description (no period for file headers)
* @TODO
* Short description (no period for file headers)
*
* Long Description.
* Long description.
*
* @link URL
* @since x.x.x (if available)
* @package TODO
* @author Your Name <email@example.com>
*/
/**
* @TODO
* Short description (no period for file headers)
*
* @package WordPress
* @subpackage Component
* Long description.
*
* @package TODO
* @author Your Name <email@example.com>
* @license GPL-2.0+
* @link http://example.com
* @copyright 2014 Your Name or Company Name
*/
class Plugin_Name_Deactivator {
/**
* TODO: Short description. (use period)
* @TODO
* Short description. (use period)
*
* TODO: Long description.
* Long description.
*
* @since x.x.x
*
* @param type $var Description.
* @param array $args {
* Short description about this hash.
*
* @type type $var Description.
* @type type $var Description.
* }
* @param type $var Description.
* @since x.x.x
* @link URL
*/
public static function deactivate() {