defining the core shared plugin name

this file is used to be shared between the dashboard and public-facing functionality. it's hooks should be defined in the specific loader

plugin-name/trunk/includes/class-plugin-name.php

@@ -1,16 +1,38 @@
 <?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 {
 
+	/**
+	 * This class is used to define common functionality that exists between
+	 * both the dashboard and the public-facing side of the website.
+	 *
+	 * If any hooks are defined in this class, then they should be defined
+	 * in their respective Loader classes (that is, Plugin_Name_Admin_Loader
+	 * or Plugin_Name_Loader).
+	 *
+	 * An instance of this class should then be passed to the loader
+	 */
+
 }