Browse Source

Added partial php documentation to the Config class

Tobias Reich 8 years ago
parent
commit
66edea4d71
1 changed files with 6 additions and 0 deletions
  1. 6 0
      php/Modules/Config.php

+ 6 - 0
php/Modules/Config.php

@@ -43,12 +43,18 @@ if(!defined('LYCHEE')) Response::error('Direct access is not allowed!');
 
 	}
 
+	/**
+	 * @return boolean Returns true when the config exists.
+	 */
 	public static function exists() {
 
 		return file_exists(LYCHEE_CONFIG_FILE);
 
 	}
 
+	/**
+	 * @return array Returns the config.
+	 */
 	public static function get() {
 
 		require(LYCHEE_CONFIG_FILE);