From f3133d8cb5baaa20ff9b6ebbf66b8b9641a07e16 Mon Sep 17 00:00:00 2001
From: Tom McFarlin <tom@tommcfarlin.com>
Date: Fri, 1 Aug 2014 16:47:08 -0400
Subject: [PATCH] Improving docblocks

* Documenting the plugin file
* Changing the docblock to read 'class', not 'file'

Related #199
---
 plugin-name/trunk/includes/class-plugin-name.php | 12 ++++++------
 plugin-name/trunk/plugin-name.php                | 10 ++++++----
 2 files changed, 12 insertions(+), 10 deletions(-)

diff --git a/plugin-name/trunk/includes/class-plugin-name.php b/plugin-name/trunk/includes/class-plugin-name.php
index 8d960d4..ddeb50c 100644
--- a/plugin-name/trunk/includes/class-plugin-name.php
+++ b/plugin-name/trunk/includes/class-plugin-name.php
@@ -1,10 +1,10 @@
 <?php
 
 /**
- * The core plugin file
+ * The core plugin class
  *
- * This is the core plugin file that is used to define internationalization,
- * dashboard-specific hooks, and public-facing site hooks.
+ * This is used to define internationalization, dashboard-specific hooks, and
+ * public-facing site hooks.
  *
  * Also maintains the unique identifier of this plugin as well as the current
  * version of the plugin.
@@ -17,10 +17,10 @@
  */
 
 /**
- * The core plugin file.
+ * The core plugin class
  *
- * This is the core plugin file that is used to define internationalization,
- * dashboard-specific hooks, and public-facing site hooks.
+ * This is used to define internationalization, dashboard-specific hooks, and
+ * public-facing site hooks.
  *
  * Also maintains the unique identifier of this plugin as well as the current
  * version of the plugin.
diff --git a/plugin-name/trunk/plugin-name.php b/plugin-name/trunk/plugin-name.php
index 6bd5534..bda6bb0 100644
--- a/plugin-name/trunk/plugin-name.php
+++ b/plugin-name/trunk/plugin-name.php
@@ -1,10 +1,12 @@
 <?php
 
 /**
-/**
- * Short Description (no period for file headers)
+ * The plugin bootstrap file
  *
- * Long Description.
+ * This file is read my WordPress to generate the plugin information in the plugin
+ * Dashboard. This file also includes all of the dependencies used by the plugin,
+ * registers the activation and deactivation functions, and defines a function
+ * this starts the plugin.
  *
  * @link              URL
  * @since             1.0.0
@@ -45,7 +47,7 @@ register_activation_hook( __FILE__, array( 'Plugin_Name_Activator', 'activate' )
 register_activation_hook( __FILE__, array( 'Plugin_Name_Deactivator', 'deactivate' ) );
 
 /**
- * This is the core plugin file that is used to define internationalization,
+ * The core plugin class that is used to define internationalization,
  * dashboard-specific hooks, and public-facing site hooks.
  */
 require_once plugin_dir_path( __FILE__ ) . 'includes/class-plugin-name.php';