From 026515da8566aae4b27c1d694d269140ea77b99f Mon Sep 17 00:00:00 2001
From: Tom McFarlin <tom@tommcfarlin.com>
Date: Fri, 25 Apr 2014 18:58:07 -0400
Subject: [PATCH] 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>
---
 .../includes/class-plugin-name-activator.php  | 21 ++++++++-----------
 .../class-plugin-name-deactivator.php         | 14 ++++++-------
 .../trunk/includes/class-plugin-name.php      | 20 ++++++++++--------
 3 files changed, 27 insertions(+), 28 deletions(-)

diff --git a/plugin-name/trunk/includes/class-plugin-name-activator.php b/plugin-name/trunk/includes/class-plugin-name-activator.php
index ad1860a..deaf0e2 100644
--- a/plugin-name/trunk/includes/class-plugin-name-activator.php
+++ b/plugin-name/trunk/includes/class-plugin-name-activator.php
@@ -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() {
 
diff --git a/plugin-name/trunk/includes/class-plugin-name-deactivator.php b/plugin-name/trunk/includes/class-plugin-name-deactivator.php
index 045197f..4d2b881 100644
--- a/plugin-name/trunk/includes/class-plugin-name-deactivator.php
+++ b/plugin-name/trunk/includes/class-plugin-name-deactivator.php
@@ -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 {
 
diff --git a/plugin-name/trunk/includes/class-plugin-name.php b/plugin-name/trunk/includes/class-plugin-name.php
index 3e3aff3..7fe8abe 100644
--- a/plugin-name/trunk/includes/class-plugin-name.php
+++ b/plugin-name/trunk/includes/class-plugin-name.php
@@ -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 {
 
 }