From 67cf0a912c8ed24c7466163fa409e8154082e1df Mon Sep 17 00:00:00 2001
From: Joas Schilling <nickvergessen@gmx.de>
Date: Sun, 13 Apr 2014 23:24:10 +0200
Subject: [ticket/10073] Add doc blocks to new classes

PHPBB3-10073
---
 phpBB/phpbb/message/admin_form.php | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

(limited to 'phpBB/phpbb/message/admin_form.php')

diff --git a/phpBB/phpbb/message/admin_form.php b/phpBB/phpbb/message/admin_form.php
index dc995062a0..5201994c73 100644
--- a/phpBB/phpbb/message/admin_form.php
+++ b/phpBB/phpbb/message/admin_form.php
@@ -9,12 +9,24 @@
 
 namespace phpbb\message;
 
+/**
+* Class admin_form
+* Displays a message to the user and allows him to send an email
+*
+* @package phpbb\message
+*/
 class admin_form extends form
 {
+	/** @var string */
 	protected $subject;
+	/** @var string */
 	protected $sender_name;
+	/** @var string */
 	protected $sender_address;
 
+	/**
+	* {inheritDoc}
+	*/
 	public function check_allow()
 	{
 		$error = parent::check_allow();
@@ -31,6 +43,9 @@ class admin_form extends form
 		return false;
 	}
 
+	/**
+	* {inheritDoc}
+	*/
 	public function bind(\phpbb\request\request_interface $request)
 	{
 		parent::bind($request);
@@ -40,6 +55,9 @@ class admin_form extends form
 		$this->sender_name = $request->variable('name', '', true);
 	}
 
+	/**
+	* {inheritDoc}
+	*/
 	public function submit(\messenger $messenger)
 	{
 		if (!$this->subject)
@@ -93,6 +111,9 @@ class admin_form extends form
 		parent::submit($messenger);
 	}
 
+	/**
+	* {inheritDoc}
+	*/
 	public function render(\phpbb\template\template $template)
 	{
 		$template->assign_vars(array(
-- 
cgit v1.2.1