From 4d6a0dfa3e970371bc8777864130f67b8bf9627d Mon Sep 17 00:00:00 2001
From: Tom McFarlin <tom@tommcfarlin.com>
Date: Mon, 18 Aug 2014 17:00:09 -0400
Subject: [PATCH] Finalizing code for beta

* Updating DocBlocks
* Fixing typos
* Adjusting whitespace
---
 plugin-name/trunk/admin/js/plugin-name-admin.js   |  6 +++---
 .../includes/class-plugin-name-activator.php      |  8 +++-----
 .../includes/class-plugin-name-deactivator.php    |  8 +++-----
 .../trunk/includes/class-plugin-name-i18n.php     |  6 +++---
 plugin-name/trunk/includes/class-plugin-name.php  |  6 +++---
 plugin-name/trunk/public/js/plugin-name-public.js |  6 +++---
 plugin-name/trunk/uninstall.php                   | 15 +++++++++------
 7 files changed, 27 insertions(+), 28 deletions(-)

diff --git a/plugin-name/trunk/admin/js/plugin-name-admin.js b/plugin-name/trunk/admin/js/plugin-name-admin.js
index f87f8ec..2633d7c 100644
--- a/plugin-name/trunk/admin/js/plugin-name-admin.js
+++ b/plugin-name/trunk/admin/js/plugin-name-admin.js
@@ -5,7 +5,7 @@
 	 * All of the code for your Dashboard-specific JavaScript source
 	 * should reside in this file.
 	 *
-	 * Note that this assume you're going to user jQuery, so it prepares
+	 * Note that this assume you're going to use jQuery, so it prepares
 	 * the $ function reference to be used within the scope of this
 	 * function.
 	 *
@@ -16,7 +16,7 @@
 	 *
 	 * });
 	 *
-	 * Or when the window is completely ready:
+	 * Or when the window is loaded:
 	 *
 	 * $( window ).load(function() {
 	 *
@@ -24,7 +24,7 @@
 	 *
 	 * ...and so on.
 	 *
-	 * Remember that ideally, we should not attach anymore than a single DOM-ready or window-load handler
+	 * Remember that ideally, we should not attach any more than a single DOM-ready or window-load handler
 	 * for any particular page. Though other scripts in WordPress core, other plugins, and other themes may
 	 * be doing this, we should try to minimize doing that in our own work.
 	 */
diff --git a/plugin-name/trunk/includes/class-plugin-name-activator.php b/plugin-name/trunk/includes/class-plugin-name-activator.php
index 3881f50..475b78d 100644
--- a/plugin-name/trunk/includes/class-plugin-name-activator.php
+++ b/plugin-name/trunk/includes/class-plugin-name-activator.php
@@ -1,9 +1,7 @@
 <?php
 
 /**
- * Short Description (no period)
- *
- * Long Description.
+ * Fired during plugin activation
  *
  * @link       http://example.com
  * @since      1.0.0
@@ -13,9 +11,9 @@
  */
 
 /**
- * Short Description. (use period)
+ * Fired during plugin activation.
  *
- * Long Description.
+ * This class defines all code necessary to run during the plugin's activation.
  *
  * @since      1.0.0
  * @package    Plugin_Name
diff --git a/plugin-name/trunk/includes/class-plugin-name-deactivator.php b/plugin-name/trunk/includes/class-plugin-name-deactivator.php
index c9a245c..548795c 100644
--- a/plugin-name/trunk/includes/class-plugin-name-deactivator.php
+++ b/plugin-name/trunk/includes/class-plugin-name-deactivator.php
@@ -1,9 +1,7 @@
 <?php
 
 /**
- * Short Description (no period)
- *
- * Long Description.
+ * Fired during plugin deactivation
  *
  * @link       http://example.com
  * @since      1.0.0
@@ -13,9 +11,9 @@
  */
 
 /**
- * Short Description. (use period)
+ * Fired during plugin deactivation.
  *
- * Long Description.
+ * This class defines all code necessary to run during the plugin's deactivation.
  *
  * @since      1.0.0
  * @package    Plugin_Name
diff --git a/plugin-name/trunk/includes/class-plugin-name-i18n.php b/plugin-name/trunk/includes/class-plugin-name-i18n.php
index 8905dfa..4123844 100644
--- a/plugin-name/trunk/includes/class-plugin-name-i18n.php
+++ b/plugin-name/trunk/includes/class-plugin-name-i18n.php
@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Define the internationalization functionality.
+ * Define the internationalization functionality
  *
  * Loads and defines the internationalization files for this plugin
  * so that its ready for translation.
@@ -27,11 +27,11 @@
 class Plugin_Name_i18n {
 
 	/**
-	 * Short Description. (use period)
+	 * The domain specified for this plugin.
 	 *
 	 * @since    1.0.0
 	 * @access   private
-	 * @var      type    $domain    Description.
+	 * @var      string    $domain    The domain identifier for this plugin.
 	 */
 	private $domain;
 
diff --git a/plugin-name/trunk/includes/class-plugin-name.php b/plugin-name/trunk/includes/class-plugin-name.php
index 12b6ba0..1e292a6 100644
--- a/plugin-name/trunk/includes/class-plugin-name.php
+++ b/plugin-name/trunk/includes/class-plugin-name.php
@@ -14,7 +14,7 @@
  */
 
 /**
- * The core plugin class
+ * The core plugin class.
  *
  * This is used to define internationalization, dashboard-specific hooks, and
  * public-facing site hooks.
@@ -35,7 +35,7 @@ class Plugin_Name {
 	 *
 	 * @since    1.0.0
 	 * @access   protected
-	 * @var      type    Plugin_Name_Loader    Maintains and registers all hooks for the plugin.
+	 * @var      Plugin_Name_Loader    $loader    Maintains and registers all hooks for the plugin.
 	 */
 	protected $loader;
 
@@ -174,7 +174,7 @@ class Plugin_Name {
 	}
 
 	/**
-	 * Execute the loader to execute all of the hooks with WordPress.
+	 * Run the loader to execute all of the hooks with WordPress.
 	 *
 	 * @since    1.0.0
 	 */
diff --git a/plugin-name/trunk/public/js/plugin-name-public.js b/plugin-name/trunk/public/js/plugin-name-public.js
index b644f71..bd4e62a 100644
--- a/plugin-name/trunk/public/js/plugin-name-public.js
+++ b/plugin-name/trunk/public/js/plugin-name-public.js
@@ -5,7 +5,7 @@
 	 * All of the code for your public-facing JavaScript source
 	 * should reside in this file.
 	 *
-	 * Note that this assume you're going to user jQuery, so it prepares
+	 * Note that this assume you're going to use jQuery, so it prepares
 	 * the $ function reference to be used within the scope of this
 	 * function.
 	 *
@@ -16,7 +16,7 @@
 	 *
 	 * });
 	 *
-	 * Or when the window is completely ready:
+	 * Or when the window is loaded:
 	 *
 	 * $( window ).load(function() {
 	 *
@@ -24,7 +24,7 @@
 	 *
 	 * ...and so on.
 	 *
-	 * Remember that ideally, we should not attach anymore than a single DOM-ready or window-load handler
+	 * Remember that ideally, we should not attach any more than a single DOM-ready or window-load handler
 	 * for any particular page. Though other scripts in WordPress core, other plugins, and other themes may
 	 * be doing this, we should try to minimize doing that in our own work.
 	 */
diff --git a/plugin-name/trunk/uninstall.php b/plugin-name/trunk/uninstall.php
index b60539f..ca18f19 100644
--- a/plugin-name/trunk/uninstall.php
+++ b/plugin-name/trunk/uninstall.php
@@ -6,12 +6,15 @@
  * When populating this file, consider the following flow
  * of control:
  *
- * - Here, onActivateNewSite() should break. This method should be static.
- * - Check if the $_REQUEST content actually is the plugin name.
- * - Check if it goes through the authentication (admin referrer checks).
- * - Check the output of $_GET and if it makes sense.
- * - Repeat with other user roles. Best directly by using the links/query string params.
- * - Repeat stuff for multisite. Once for a single site in the network, once sitewide.
+ * - This method should be static
+ * - Check if the $_REQUEST content actually is the plugin name
+ * - Run an admin referrer check to make sure it goes through authentication
+ * - Verify the output of $_GET makes sense
+ * - Repeat with other user roles. Best directly by using the links/query string parameters.
+ * - Repeat things for multisite. Once for a single site in the network, once sitewide.
+ *
+ * This file may be updated more in future version of the Boilerplate; however, this is the
+ * general skeleton and outline for how the file should work.
  *
  * For more information, see the following discussion:
  * https://github.com/tommcfarlin/WordPress-Plugin-Boilerplate/pull/123#issuecomment-28541913