From ec614227b72462d100b007f5f69b8d12edad5399 Mon Sep 17 00:00:00 2001
From: Chris Olbekson <chris.olbekson@x-team.com>
Date: Thu, 3 Apr 2014 19:27:16 -0500
Subject: [PATCH] Added documentation to the new install / update methods

---
 includes/install.php | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/includes/install.php b/includes/install.php
index 0a9eef790..17f568d67 100755
--- a/includes/install.php
+++ b/includes/install.php
@@ -28,6 +28,7 @@ class WP_Stream_Install {
 
 	/**
 	 * URL to the Stream Admin settings page.
+	 *
 	 * @access public
 	 * @var string
 	 */
@@ -59,7 +60,6 @@ public static function get_instance() {
 	 * Sets static class properties
 	 */
 	function __construct() {
-
 		global $wpdb;
 		self::$current = WP_Stream::VERSION;
 
@@ -83,7 +83,6 @@ function __construct() {
 	 * If database update required admin notice will be given
 	 * on the plugin update screen
 	 *
-	 * @action pre_current_active_plugins
 	 * @return null
 	 */
 	private static function check() {
@@ -115,6 +114,11 @@ public static function prompt_update() {
 		<?php
 	}
 
+	/**
+	 * When user initiates a database update this function calls the update methods, checks for success
+	 * updates the stream_db version number in the database and outputs a success and continue message
+	 *
+	 */
 	public static function prompt_update_status() {
 		$success_db = self::update( self::$db_version, self::$current );
 		if ( $success_db && self::$current === $success_db ) {
@@ -134,6 +138,12 @@ public static function prompt_update_status() {
 		<?php
 	}
 
+	/**
+	 * Added to the admin_notices hook when file plugin version is higher than database plugin version
+	 *
+	 * @action admin_notices
+	 * @return void
+	 */
 	public static function update_notice_hook() {
 		if ( ! isset( $_REQUEST['wp_stream_update'] ) ) {
 			self::prompt_update();