From: Kunal Mehta <legoktm@gmail.com>
Date: Thu, 14 May 2015 05:28:20 +0000 (-0700)
Subject: registration: Improve docs for return value of Processor::getExtractedInfo()
X-Git-Tag: 1.31.0-rc.0~11411^2
X-Git-Url: http://git.cyclocoop.org/%7B%24admin_url%7Dcompta/comptes/journal.php?a=commitdiff_plain;h=2252fc6d0f64531bd168b1975a4dd62b9af608db;p=lhc%2Fweb%2Fwiklou.git

registration: Improve docs for return value of Processor::getExtractedInfo()

Change-Id: I0246e705134ee3545af592c06aaf6b157bc64e5f
---

diff --git a/includes/registration/Processor.php b/includes/registration/Processor.php
index e930fd3e51..391f1085b6 100644
--- a/includes/registration/Processor.php
+++ b/includes/registration/Processor.php
@@ -21,7 +21,12 @@ interface Processor {
 	public function extractInfo( $path, array $info );
 
 	/**
-	 * @return array With 'globals', 'defines', 'callbacks', 'credits' keys.
+	 * @return array With following keys:
+	 * 		'globals' - variables to be set to $GLOBALS
+	 * 		'defines' - constants to define
+	 * 		'callbacks' - functions to be executed by the registry
+	 * 		'credits' - metadata to be stored by registry
+	 * 		'attributes' - registration info which isn't a global variable
 	 */
 	public function getExtractedInfo();
 }