Merge "registration: Improve docs for return value of Processor::getExtractedInfo()"
authorjenkins-bot <jenkins-bot@gerrit.wikimedia.org>
Thu, 14 May 2015 07:00:32 +0000 (07:00 +0000)
committerGerrit Code Review <gerrit@wikimedia.org>
Thu, 14 May 2015 07:00:32 +0000 (07:00 +0000)
includes/registration/Processor.php

index e930fd3..391f108 100644 (file)
@@ -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();
 }