Add @since tags to all methods in public namespace

* enhance the app development experience - you can look up the
  method introduction right inside the code without searching
  via git blame
* easier to write apps for multiple versions

1 files changed, 18 insertions, 0 deletions

diff --git a/lib/public/iconfig.php b/lib/public/iconfig.php
index f28a114a2bb..ff0b6c6a5b0 100644
--- a/lib/public/iconfig.php
+++ b/lib/public/iconfig.php
@@ -37,6 +37,7 @@ namespace OCP;
 
 /**
  * Access to all the configuration options ownCloud offers
+ * @since 6.0.0
  */
 interface IConfig {
 	/**
@@ -44,6 +45,7 @@ interface IConfig {
 	 *
 	 * @param array $configs Associative array with `key => value` pairs
 	 *                       If value is null, the config key will be deleted
+	 * @since 8.0.0
 	 */
 	public function setSystemValues(array $configs);
 
@@ -52,6 +54,7 @@ interface IConfig {
 	 *
 	 * @param string $key the key of the value, under which will be saved
 	 * @param mixed $value the value that should be stored
+	 * @since 8.0.0
 	 */
 	public function setSystemValue($key, $value);
 
@@ -61,6 +64,7 @@ interface IConfig {
 	 * @param string $key the key of the value, under which it was saved
 	 * @param mixed $default the default value to be returned if the value isn't set
 	 * @return mixed the value or $default
+	 * @since 6.0.0 - parameter $default was added in 7.0.0
 	 */
 	public function getSystemValue($key, $default = '');
 
@@ -68,6 +72,7 @@ interface IConfig {
 	 * Delete a system wide defined value
 	 *
 	 * @param string $key the key of the value, under which it was saved
+	 * @since 8.0.0
 	 */
 	public function deleteSystemValue($key);
 
@@ -76,6 +81,7 @@ interface IConfig {
 	 *
 	 * @param string $appName the appName that we stored the value under
 	 * @return string[] the keys stored for the app
+	 * @since 8.0.0
 	 */
 	public function getAppKeys($appName);
 
@@ -86,6 +92,7 @@ interface IConfig {
 	 * @param string $key the key of the value, under which will be saved
 	 * @param string $value the value that should be stored
 	 * @return void
+	 * @since 6.0.0
 	 */
 	public function setAppValue($appName, $key, $value);
 
@@ -96,6 +103,7 @@ interface IConfig {
 	 * @param string $key the key of the value, under which it was saved
 	 * @param string $default the default value to be returned if the value isn't set
 	 * @return string the saved value
+	 * @since 6.0.0 - parameter $default was added in 7.0.0
 	 */
 	public function getAppValue($appName, $key, $default = '');
 
@@ -104,6 +112,7 @@ interface IConfig {
 	 *
 	 * @param string $appName the appName that we stored the value under
 	 * @param string $key the key of the value, under which it was saved
+	 * @since 8.0.0
 	 */
 	public function deleteAppValue($appName, $key);
 
@@ -111,6 +120,7 @@ interface IConfig {
 	 * Removes all keys in appconfig belonging to the app
 	 *
 	 * @param string $appName the appName the configs are stored under
+	 * @since 8.0.0
 	 */
 	public function deleteAppValues($appName);
 
@@ -124,6 +134,7 @@ interface IConfig {
 	 * @param string $value the value that you want to store
 	 * @param string $preCondition only update if the config value was previously the value passed as $preCondition
 	 * @throws \OCP\PreConditionNotMetException if a precondition is specified and is not met
+	 * @since 6.0.0 - parameter $precondition was added in 8.0.0
 	 */
 	public function setUserValue($userId, $appName, $key, $value, $preCondition = null);
 
@@ -135,6 +146,7 @@ interface IConfig {
 	 * @param string $key the key under which the value is being stored
 	 * @param mixed $default the default value to be returned if the value isn't set
 	 * @return string
+	 * @since 6.0.0 - parameter $default was added in 7.0.0
 	 */
 	public function getUserValue($userId, $appName, $key, $default = '');
 
@@ -145,6 +157,7 @@ interface IConfig {
 	 * @param string $key the key to get the value for
 	 * @param array $userIds the user IDs to fetch the values for
 	 * @return array Mapped values: userId => value
+	 * @since 8.0.0
 	 */
 	public function getUserValueForUsers($appName, $key, $userIds);
 
@@ -154,6 +167,7 @@ interface IConfig {
 	 * @param string $userId the userId of the user that we want to store the value under
 	 * @param string $appName the appName that we stored the value under
 	 * @return string[]
+	 * @since 8.0.0
 	 */
 	public function getUserKeys($userId, $appName);
 
@@ -163,6 +177,7 @@ interface IConfig {
 	 * @param string $userId the userId of the user that we want to store the value under
 	 * @param string $appName the appName that we stored the value under
 	 * @param string $key the key under which the value is being stored
+	 * @since 8.0.0
 	 */
 	public function deleteUserValue($userId, $appName, $key);
 
@@ -170,6 +185,7 @@ interface IConfig {
 	 * Delete all user values
 	 *
 	 * @param string $userId the userId of the user that we want to remove all values from
+	 * @since 8.0.0
 	 */
 	public function deleteAllUserValues($userId);
 
@@ -177,6 +193,7 @@ interface IConfig {
 	 * Delete all user related values of one app
 	 *
 	 * @param string $appName the appName of the app that we want to remove all values from
+	 * @since 8.0.0
 	 */
 	public function deleteAppFromAllUsers($appName);
 
@@ -187,6 +204,7 @@ interface IConfig {
 	 * @param string $key the key to get the user for
 	 * @param string $value the value to get the user for
 	 * @return array of user IDs
+	 * @since 8.0.0
 	 */
 	public function getUsersForUserValue($appName, $key, $value);
 }