More documentation for the config file

lib/trest_init.php

@@ -4,11 +4,17 @@
  * procedural file used to setup the TRest library
  *
  * @author Marcos Mercedes <marcos.mercedesn@gmail.com>
+ * @package TRest
  */
 namespace TRest;
 
 define('TREST_LIB_PATH', __DIR__);
 define('TREST_LIB_THIRD_PARTY_PATH', TREST_LIB_PATH . DIRECTORY_SEPARATOR . '..' . DIRECTORY_SEPARATOR . 'ThirdParty');
+/**
+ *
+ * @var integer the amount of time in seconds that will be used by default save
+ *      cache for the responses
+ */
 define('TREST_DEFAULT_CACHE_TTL', 120);
 
 use TRest\Config\TRestConfigFactory;
@@ -26,6 +32,10 @@
  * Perfect Tree <http://pixelpt.com/>
  */
 
+/**
+ * The config named 'default' will be used for the models without the property
+ * => protected static $configName = 'StackOverflow';
+ */
 TRestConfigFactory::add('default', new TRestConfig(array(
     'apiUrl' => 'http://pixelpt-sandwich-api.herokuapp.com/',
     'singleItemNode' => 'sandwich',
@@ -36,6 +46,10 @@
  * Stack overflow public used to look for users data
  */
 
+/**
+ * The model with this property value will use this configuration => protected
+ * static $configName = 'StackOverflow';
+ */
 TRestConfigFactory::add('StackOverflow', new TRestConfig(array(
     'apiUrl' => 'http://api.stackoverflow.com/1.1/',
     'cacheAdapter' => new TRestFastCache()