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

PHPBB3-9550
---
 phpBB/includes/functions.php | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/phpBB/includes/functions.php b/phpBB/includes/functions.php
index 43bdb757e5..949b66072b 100644
--- a/phpBB/includes/functions.php
+++ b/phpBB/includes/functions.php
@@ -5187,6 +5187,12 @@ function garbage_collection()
 	global $cache, $db;
 	global $phpbb_dispatcher;
 
+	/**
+	* Unload some objects, to free some memory, before we finish our task
+	*
+	* @event core.garbage_collection
+	* @since 3.1-A1
+	*/
 	$phpbb_dispatcher->dispatch('core.garbage_collection');
 
 	// Unload cache, must be done before the DB connection if closed