From f96dac335287f2fd51ff6628facbc8b6af6a517f Mon Sep 17 00:00:00 2001
From: Nathan Guse <nathaniel.guse@gmail.com>
Date: Thu, 18 Oct 2012 19:13:47 -0500
Subject: [ticket/11103] Interface docblocks

PHPBB3-11103
---
 phpBB/includes/notification/method/email.php     |  3 +++
 phpBB/includes/notification/method/interface.php | 19 +++++++++++++++++++
 2 files changed, 22 insertions(+)

(limited to 'phpBB/includes/notification/method')

diff --git a/phpBB/includes/notification/method/email.php b/phpBB/includes/notification/method/email.php
index c2e272aca1..e902ea1e85 100644
--- a/phpBB/includes/notification/method/email.php
+++ b/phpBB/includes/notification/method/email.php
@@ -40,6 +40,9 @@ class phpbb_notification_method_email extends phpbb_notification_method_base
 		return true;
 	}
 
+	/**
+	* Parse the queue and notify the users
+	*/
 	public function notify()
 	{
 		if (!sizeof($this->queue))
diff --git a/phpBB/includes/notification/method/interface.php b/phpBB/includes/notification/method/interface.php
index 4b990ec9fa..f5c210a2fc 100644
--- a/phpBB/includes/notification/method/interface.php
+++ b/phpBB/includes/notification/method/interface.php
@@ -21,7 +21,26 @@ if (!defined('IN_PHPBB'))
 */
 interface phpbb_notification_method_interface
 {
+	/**
+	* Is this method available for the user?
+	* This is checked on the notifications options
+	*/
 	public function is_available();
 
+	/**
+	* Add a notification to the queue
+	*
+	* @param phpbb_notification_type_interface $notification
+	*/
+	public function add_to_queue(phpbb_notification_type_interface $notification);
+
+	/**
+	* Empty the queue
+	*/
+	protected function empty_queue();
+
+	/**
+	* Parse the queue and notify the users
+	*/
 	public function notify();
 }
-- 
cgit v1.2.1