From 997075a008b594f62306184aeb9105d5180fdd6d Mon Sep 17 00:00:00 2001
From: Joas Schilling <nickvergessen@gmx.de>
Date: Sun, 5 Aug 2012 16:46:57 +0200
Subject: [PATCH] [feature/php-events] Add docs for core.page_footer

PHPBB3-9550
---
 phpBB/includes/functions.php | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/phpBB/includes/functions.php b/phpBB/includes/functions.php
index e39d5ee13e..43bdb757e5 100644
--- a/phpBB/includes/functions.php
+++ b/phpBB/includes/functions.php
@@ -5080,12 +5080,20 @@ function page_header($page_title = '', $display_online_list = true, $item_id = 0
 function page_footer($run_cron = true)
 {
 	global $db, $config, $template, $user, $auth, $cache, $starttime, $phpbb_root_path, $phpEx;
-	global $request;
-	global $phpbb_dispatcher;
+	global $request, $phpbb_dispatcher;
 
 	// A listener can set this variable to `true` when it overrides this function
 	$page_footer_override = false;
 
+	/**
+	* Execute code and/or overwrite  page_footer()
+	*
+	* @event core.page_footer
+	* @var	bool	run_cron			Shall we run cron tasks
+	* @var	bool	page_footer_override	Shall we return instead of running
+	*										the rest of page_footer()
+	* @since 3.1-A1
+	*/
 	$vars = array('run_cron', 'page_footer_override');
 	extract($phpbb_dispatcher->trigger_event('core.page_footer', compact($vars)));