Fix missing @since tags in OCP

This commit is contained in:
Morris Jobke 2015-06-19 10:51:36 +02:00
parent ba43ec974c
commit eddbdb8f21
9 changed files with 28 additions and 1 deletions

View File

@ -34,6 +34,7 @@ class DoesNotExistException extends \Exception {
/** /**
* Constructor * Constructor
* @param string $msg the error message * @param string $msg the error message
* @since 7.0.0
*/ */
public function __construct($msg){ public function __construct($msg){
parent::__construct($msg); parent::__construct($msg);

View File

@ -92,6 +92,10 @@ abstract class Entity {
$this->_updatedFields = array(); $this->_updatedFields = array();
} }
/**
* Generic setter for properties
* @since 7.0.0
*/
protected function setter($name, $args) { protected function setter($name, $args) {
// setters should only work for existing attributes // setters should only work for existing attributes
if(property_exists($this, $name)){ if(property_exists($this, $name)){
@ -112,6 +116,10 @@ abstract class Entity {
} }
} }
/**
* Generic getter for properties
* @since 7.0.0
*/
protected function getter($name) { protected function getter($name) {
// getters should only work for existing attributes // getters should only work for existing attributes
if(property_exists($this, $name)){ if(property_exists($this, $name)){
@ -148,6 +156,7 @@ abstract class Entity {
/** /**
* Mark am attribute as updated * Mark am attribute as updated
* @param string $attribute the name of the attribute * @param string $attribute the name of the attribute
* @since 7.0.0
*/ */
protected function markFieldUpdated($attribute){ protected function markFieldUpdated($attribute){
$this->_updatedFields[$attribute] = true; $this->_updatedFields[$attribute] = true;
@ -212,6 +221,7 @@ abstract class Entity {
* that value once its being returned from the database * that value once its being returned from the database
* @param string $fieldName the name of the attribute * @param string $fieldName the name of the attribute
* @param string $type the type which will be used to call settype() * @param string $type the type which will be used to call settype()
* @since 7.0.0
*/ */
protected function addType($fieldName, $type){ protected function addType($fieldName, $type){
$this->_fieldTypes[$fieldName] = $type; $this->_fieldTypes[$fieldName] = $type;

View File

@ -193,6 +193,7 @@ abstract class Mapper {
* Checks if an array is associative * Checks if an array is associative
* @param array $array * @param array $array
* @return bool true if associative * @return bool true if associative
* @since 8.1.0
*/ */
private function isAssocArray(array $array) { private function isAssocArray(array $array) {
return array_values($array) !== $array; return array_values($array) !== $array;
@ -202,6 +203,7 @@ abstract class Mapper {
* Returns the correct PDO constant based on the value type * Returns the correct PDO constant based on the value type
* @param $value * @param $value
* @return PDO constant * @return PDO constant
* @since 8.1.0
*/ */
private function getPDOType($value) { private function getPDOType($value) {
switch (gettype($value)) { switch (gettype($value)) {

View File

@ -34,6 +34,7 @@ class MultipleObjectsReturnedException extends \Exception {
/** /**
* Constructor * Constructor
* @param string $msg the error message * @param string $msg the error message
* @since 7.0.0
*/ */
public function __construct($msg){ public function __construct($msg){
parent::__construct($msg); parent::__construct($msg);

View File

@ -48,6 +48,7 @@ class Defaults {
/** /**
* creates a \OC_Defaults instance which is used in all methods to retrieve the * creates a \OC_Defaults instance which is used in all methods to retrieve the
* actual defaults * actual defaults
* @since 6.0.0
*/ */
function __construct() { function __construct() {
$this->defaults = new \OC_Defaults(); $this->defaults = new \OC_Defaults();

View File

@ -107,6 +107,7 @@ interface Folder extends Node {
* @param string $path relative path of the new file * @param string $path relative path of the new file
* @return \OCP\Files\File * @return \OCP\Files\File
* @throws \OCP\Files\NotPermittedException * @throws \OCP\Files\NotPermittedException
* @since 6.0.0
*/ */
public function newFile($path); public function newFile($path);

View File

@ -41,12 +41,20 @@ class LockNotAcquiredException extends \Exception {
/** @var integer $lockType The type of the lock that was attempted */ /** @var integer $lockType The type of the lock that was attempted */
public $lockType; public $lockType;
/**
* @since 7.0.0
*/
public function __construct($path, $lockType, $code = 0, \Exception $previous = null) { 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)); $message = \OC::$server->getL10N('core')->t('Could not obtain lock type %d on "%s".', array($lockType, $path));
parent::__construct($message, $code, $previous); parent::__construct($message, $code, $previous);
} }
// custom string representation of object /**
* custom string representation of object
*
* @return string
* @since 7.0.0
*/
public function __toString() { public function __toString() {
return __CLASS__ . ": [{$this->code}]: {$this->message}\n"; return __CLASS__ . ": [{$this->code}]: {$this->message}\n";
} }

View File

@ -93,6 +93,7 @@ interface IUser {
* get the users home folder to mount * get the users home folder to mount
* *
* @return string * @return string
* @since 8.0.0
*/ */
public function getHome(); public function getHome();
@ -116,6 +117,7 @@ interface IUser {
* check if the backend supports changing passwords * check if the backend supports changing passwords
* *
* @return bool * @return bool
* @since 8.0.0
*/ */
public function canChangePassword(); public function canChangePassword();

View File

@ -64,6 +64,7 @@ interface IUserManager {
/** /**
* remove all user backends * remove all user backends
* @since 8.0.0
*/ */
public function clearBackends() ; public function clearBackends() ;