From eddbdb8f21e9bbd1ff1a6b20140cdad93b6156d3 Mon Sep 17 00:00:00 2001 From: Morris Jobke Date: Fri, 19 Jun 2015 10:51:36 +0200 Subject: [PATCH] Fix missing @since tags in OCP --- lib/public/appframework/db/doesnotexistexception.php | 1 + lib/public/appframework/db/entity.php | 10 ++++++++++ lib/public/appframework/db/mapper.php | 2 ++ .../db/multipleobjectsreturnedexception.php | 1 + lib/public/defaults.php | 1 + lib/public/files/folder.php | 1 + lib/public/files/locknotacquiredexception.php | 10 +++++++++- lib/public/iuser.php | 2 ++ lib/public/iusermanager.php | 1 + 9 files changed, 28 insertions(+), 1 deletion(-) diff --git a/lib/public/appframework/db/doesnotexistexception.php b/lib/public/appframework/db/doesnotexistexception.php index 6df0477498c..2cefa0fe827 100644 --- a/lib/public/appframework/db/doesnotexistexception.php +++ b/lib/public/appframework/db/doesnotexistexception.php @@ -34,6 +34,7 @@ class DoesNotExistException extends \Exception { /** * Constructor * @param string $msg the error message + * @since 7.0.0 */ public function __construct($msg){ parent::__construct($msg); diff --git a/lib/public/appframework/db/entity.php b/lib/public/appframework/db/entity.php index a12f759357e..f7beebef154 100644 --- a/lib/public/appframework/db/entity.php +++ b/lib/public/appframework/db/entity.php @@ -92,6 +92,10 @@ abstract class Entity { $this->_updatedFields = array(); } + /** + * Generic setter for properties + * @since 7.0.0 + */ protected function setter($name, $args) { // setters should only work for existing attributes if(property_exists($this, $name)){ @@ -112,6 +116,10 @@ abstract class Entity { } } + /** + * Generic getter for properties + * @since 7.0.0 + */ protected function getter($name) { // getters should only work for existing attributes if(property_exists($this, $name)){ @@ -148,6 +156,7 @@ abstract class Entity { /** * Mark am attribute as updated * @param string $attribute the name of the attribute + * @since 7.0.0 */ protected function markFieldUpdated($attribute){ $this->_updatedFields[$attribute] = true; @@ -212,6 +221,7 @@ abstract class Entity { * that value once its being returned from the database * @param string $fieldName the name of the attribute * @param string $type the type which will be used to call settype() + * @since 7.0.0 */ protected function addType($fieldName, $type){ $this->_fieldTypes[$fieldName] = $type; diff --git a/lib/public/appframework/db/mapper.php b/lib/public/appframework/db/mapper.php index 157bea36916..2b99c99b71e 100644 --- a/lib/public/appframework/db/mapper.php +++ b/lib/public/appframework/db/mapper.php @@ -193,6 +193,7 @@ abstract class Mapper { * Checks if an array is associative * @param array $array * @return bool true if associative + * @since 8.1.0 */ private function isAssocArray(array $array) { return array_values($array) !== $array; @@ -202,6 +203,7 @@ abstract class Mapper { * Returns the correct PDO constant based on the value type * @param $value * @return PDO constant + * @since 8.1.0 */ private function getPDOType($value) { switch (gettype($value)) { diff --git a/lib/public/appframework/db/multipleobjectsreturnedexception.php b/lib/public/appframework/db/multipleobjectsreturnedexception.php index cdfb748b145..988bf6bb033 100644 --- a/lib/public/appframework/db/multipleobjectsreturnedexception.php +++ b/lib/public/appframework/db/multipleobjectsreturnedexception.php @@ -34,6 +34,7 @@ class MultipleObjectsReturnedException extends \Exception { /** * Constructor * @param string $msg the error message + * @since 7.0.0 */ public function __construct($msg){ parent::__construct($msg); diff --git a/lib/public/defaults.php b/lib/public/defaults.php index 2d55a64f002..723c6ecbb78 100644 --- a/lib/public/defaults.php +++ b/lib/public/defaults.php @@ -48,6 +48,7 @@ class Defaults { /** * creates a \OC_Defaults instance which is used in all methods to retrieve the * actual defaults + * @since 6.0.0 */ function __construct() { $this->defaults = new \OC_Defaults(); diff --git a/lib/public/files/folder.php b/lib/public/files/folder.php index f5f91e8158c..533e490634f 100644 --- a/lib/public/files/folder.php +++ b/lib/public/files/folder.php @@ -107,6 +107,7 @@ interface Folder extends Node { * @param string $path relative path of the new file * @return \OCP\Files\File * @throws \OCP\Files\NotPermittedException + * @since 6.0.0 */ public function newFile($path); diff --git a/lib/public/files/locknotacquiredexception.php b/lib/public/files/locknotacquiredexception.php index 66e131ab1e5..d078ff34818 100644 --- a/lib/public/files/locknotacquiredexception.php +++ b/lib/public/files/locknotacquiredexception.php @@ -41,12 +41,20 @@ class LockNotAcquiredException extends \Exception { /** @var integer $lockType The type of the lock that was attempted */ public $lockType; + /** + * @since 7.0.0 + */ public function __construct($path, $lockType, $code = 0, \Exception $previous = null) { $message = \OC::$server->getL10N('core')->t('Could not obtain lock type %d on "%s".', array($lockType, $path)); parent::__construct($message, $code, $previous); } - // custom string representation of object + /** + * custom string representation of object + * + * @return string + * @since 7.0.0 + */ public function __toString() { return __CLASS__ . ": [{$this->code}]: {$this->message}\n"; } diff --git a/lib/public/iuser.php b/lib/public/iuser.php index 393ab90d260..6cbcfbf2312 100644 --- a/lib/public/iuser.php +++ b/lib/public/iuser.php @@ -93,6 +93,7 @@ interface IUser { * get the users home folder to mount * * @return string + * @since 8.0.0 */ public function getHome(); @@ -116,6 +117,7 @@ interface IUser { * check if the backend supports changing passwords * * @return bool + * @since 8.0.0 */ public function canChangePassword(); diff --git a/lib/public/iusermanager.php b/lib/public/iusermanager.php index 212d21759b0..e3857d6231a 100644 --- a/lib/public/iusermanager.php +++ b/lib/public/iusermanager.php @@ -64,6 +64,7 @@ interface IUserManager { /** * remove all user backends + * @since 8.0.0 */ public function clearBackends() ;