registration: Improve docs for return value of Processor::getExtractedInfo()
authorKunal Mehta <legoktm@gmail.com>
Thu, 14 May 2015 05:28:20 +0000 (22:28 -0700)
committerKunal Mehta <legoktm@gmail.com>
Thu, 14 May 2015 05:28:20 +0000 (22:28 -0700)
Change-Id: I0246e705134ee3545af592c06aaf6b157bc64e5f

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();
 }