diff options
Diffstat (limited to 'lib')
72 files changed, 482 insertions, 482 deletions
diff --git a/lib/autoloader.php b/lib/autoloader.php index 3451f799e18..2ce36385081 100644 --- a/lib/autoloader.php +++ b/lib/autoloader.php @@ -147,7 +147,7 @@ class Autoloader { } /** - * @brief Sets the optional low-latency cache for class to path mapping. + * Sets the optional low-latency cache for class to path mapping. * @param \OC\Memcache\Cache $memoryCache Instance of memory cache. */ public function setMemoryCache(\OC\Memcache\Cache $memoryCache = null) { diff --git a/lib/base.php b/lib/base.php index aa5a9d0010a..abb76b94a5d 100644 --- a/lib/base.php +++ b/lib/base.php @@ -666,7 +666,7 @@ class OC { } /** - * @brief Handle the request + * Handle the request */ public static function handleRequest() { $l = \OC_L10N::get('lib'); diff --git a/lib/private/app.php b/lib/private/app.php index a35248f2552..575cc9f41af 100644 --- a/lib/private/app.php +++ b/lib/private/app.php @@ -37,7 +37,7 @@ class OC_App{ static private $altLogin = array(); /** - * @brief clean the appid + * clean the appid * @param string|boolean $app Appid that needs to be cleaned * @return string */ @@ -46,7 +46,7 @@ class OC_App{ } /** - * @brief loads all apps + * loads all apps * @param array $types * @return bool * @@ -187,7 +187,7 @@ class OC_App{ } /** - * @brief checks whether or not an app is enabled + * checks whether or not an app is enabled * @param string $app app * @return bool * @@ -202,7 +202,7 @@ class OC_App{ } /** - * @brief enables an app + * enables an app * @param mixed $app app * @throws \Exception * @return void @@ -250,7 +250,7 @@ class OC_App{ } /** - * @brief disables an app + * disables an app * @param string $app app * @return boolean|null * @@ -269,7 +269,7 @@ class OC_App{ } /** - * @brief adds an entry to the navigation + * adds an entry to the navigation * @param array $data array containing the data * @return bool * @@ -291,7 +291,7 @@ class OC_App{ } /** - * @brief marks a navigation entry as active + * marks a navigation entry as active * @param string $id id of the entry * @return bool * @@ -305,7 +305,7 @@ class OC_App{ } /** - * @brief Get the navigation entries for the $app + * Get the navigation entries for the $app * @param string $app app * @return array an array of the $data added with addNavigationEntry * @@ -321,7 +321,7 @@ class OC_App{ } /** - * @brief gets the active Menu entry + * gets the active Menu entry * @return string id or empty string * * This function returns the id of the active navigation entry (set by @@ -332,7 +332,7 @@ class OC_App{ } /** - * @brief Returns the Settings Navigation + * Returns the Settings Navigation * @return string * * This function returns an array containing all settings pages added. The @@ -500,7 +500,7 @@ class OC_App{ } /** - * @brief Read all app metadata from the info.xml file + * Read all app metadata from the info.xml file * @param string $appid id of the app or the path of the info.xml file * @param boolean $path (optional) * @return array @@ -567,7 +567,7 @@ class OC_App{ } /** - * @brief Returns the navigation + * Returns the navigation * @return array * * This function returns an array containing all entries added. The @@ -659,7 +659,7 @@ class OC_App{ } /** - * @brief: get a list of all apps in the apps folder + * get a list of all apps in the apps folder * @return array an array of app names (string IDs) * @todo: change the name of this method to getInstalledApps, which is more accurate */ @@ -692,7 +692,7 @@ class OC_App{ } /** - * @brief: Lists all apps, this is used in apps.php + * Lists all apps, this is used in apps.php * @return array */ public static function listAllApps() { @@ -766,7 +766,7 @@ class OC_App{ } /** - * @brief: Internal custom sort funtion to bring the app into the right order. Should only be called by listAllApps + * Internal custom sort funtion to bring the app into the right order. Should only be called by listAllApps * @return array */ private static function customSort($a, $b) { @@ -796,7 +796,7 @@ class OC_App{ } /** - * @brief: get a list of all apps on apps.owncloud.com + * get a list of all apps on apps.owncloud.com * @return array, multi-dimensional array of apps. * Keys: id, name, type, typename, personid, license, detailpage, preview, changed, description */ diff --git a/lib/private/appconfig.php b/lib/private/appconfig.php index 5fba7514de0..e2a961b1d6d 100644 --- a/lib/private/appconfig.php +++ b/lib/private/appconfig.php @@ -89,7 +89,7 @@ class AppConfig implements \OCP\IAppConfig { } /** - * @brief Get all apps using the config + * Get all apps using the config * @return array an array of app ids * * This function returns a list of all apps that have at least one @@ -107,7 +107,7 @@ class AppConfig implements \OCP\IAppConfig { } /** - * @brief Get the available keys for an app + * Get the available keys for an app * @param string $app the app we are looking for * @return array an array of key names * @@ -122,7 +122,7 @@ class AppConfig implements \OCP\IAppConfig { } /** - * @brief Gets the config value + * Gets the config value * @param string $app app * @param string $key key * @param string $default = null, default value if the key does not exist @@ -141,7 +141,7 @@ class AppConfig implements \OCP\IAppConfig { } /** - * @brief check if a key is set in the appconfig + * check if a key is set in the appconfig * @param string $app * @param string $key * @return bool @@ -152,7 +152,7 @@ class AppConfig implements \OCP\IAppConfig { } /** - * @brief sets a value in the appconfig + * sets a value in the appconfig * @param string $app app * @param string $key key * @param string $value value @@ -185,7 +185,7 @@ class AppConfig implements \OCP\IAppConfig { } /** - * @brief Deletes a key + * Deletes a key * @param string $app app * @param string $key key * @return boolean|null @@ -202,7 +202,7 @@ class AppConfig implements \OCP\IAppConfig { } /** - * @brief Remove app from appconfig + * Remove app from appconfig * @param string $app app * @return boolean|null * diff --git a/lib/private/appframework/core/api.php b/lib/private/appframework/core/api.php index 5f2035389b7..ba6b9f95cb2 100644 --- a/lib/private/appframework/core/api.php +++ b/lib/private/appframework/core/api.php @@ -119,7 +119,7 @@ class API implements IApi{ } /** - * @brief connects a function to a hook + * connects a function to a hook * @param string $signalClass class name of emitter * @param string $signalName name of signal * @param string $slotClass class name of slot @@ -133,7 +133,7 @@ class API implements IApi{ } /** - * @brief Emits a signal. To get data from the slot use references! + * Emits a signal. To get data from the slot use references! * @param string $signalClass class name of emitter * @param string $signalName name of signal * @param array $params default: array() array with additional data @@ -144,7 +144,7 @@ class API implements IApi{ } /** - * @brief clear hooks + * clear hooks * @param string $signalClass * @param string $signalName */ diff --git a/lib/private/avatar.php b/lib/private/avatar.php index 45959798476..2286b896878 100644 --- a/lib/private/avatar.php +++ b/lib/private/avatar.php @@ -15,7 +15,7 @@ class OC_Avatar implements \OCP\IAvatar { private $view; /** - * @brief constructor + * constructor * @param string $user user to do avatar-management with */ public function __construct ($user) { @@ -23,7 +23,7 @@ class OC_Avatar implements \OCP\IAvatar { } /** - * @brief get the users avatar + * get the users avatar * @param int $size size in px of the avatar, avatars are square, defaults to 64 * @return boolean|\OC_Image containing the avatar or false if there's no image */ @@ -43,7 +43,7 @@ class OC_Avatar implements \OCP\IAvatar { } /** - * @brief sets the users avatar + * sets the users avatar * @param \OC_Image|resource|string $data OC_Image, imagedata or path to set a new avatar * @throws Exception if the provided file is not a jpg or png image * @throws Exception if the provided image is not valid @@ -81,7 +81,7 @@ class OC_Avatar implements \OCP\IAvatar { } /** - * @brief remove the users avatar + * remove the users avatar * @return void */ public function remove () { diff --git a/lib/private/avatarmanager.php b/lib/private/avatarmanager.php index f462e6ac5fd..6abe87c4f41 100644 --- a/lib/private/avatarmanager.php +++ b/lib/private/avatarmanager.php @@ -15,7 +15,7 @@ use OCP\IAvatarManager; class AvatarManager implements IAvatarManager { /** - * @brief return a user specific instance of \OCP\IAvatar + * return a user specific instance of \OCP\IAvatar * @see \OCP\IAvatar * @param string $user the ownCloud user id * @return \OCP\IAvatar diff --git a/lib/private/backgroundjob.php b/lib/private/backgroundjob.php index afc3c270405..922824753b0 100644 --- a/lib/private/backgroundjob.php +++ b/lib/private/backgroundjob.php @@ -25,7 +25,7 @@ */ class OC_BackgroundJob{ /** - * @brief get the execution type of background jobs + * get the execution type of background jobs * @return string * * This method returns the type how background jobs are executed. If the user @@ -36,7 +36,7 @@ class OC_BackgroundJob{ } /** - * @brief sets the background jobs execution type + * sets the background jobs execution type * @param string $type execution type * @return false|null * diff --git a/lib/private/config.php b/lib/private/config.php index 4242682af3d..82a1c46c9d5 100644 --- a/lib/private/config.php +++ b/lib/private/config.php @@ -64,7 +64,7 @@ class Config { } /** - * @brief Lists all available config keys + * Lists all available config keys * @return array an array of key names * * This function returns all keys saved in config.php. Please note that it @@ -75,7 +75,7 @@ class Config { } /** - * @brief Gets a value from config.php + * Gets a value from config.php * @param string $key key * @param mixed $default = null default value * @return mixed the value or $default @@ -92,7 +92,7 @@ class Config { } /** - * @brief Sets a value + * Sets a value * @param string $key key * @param mixed $value value * @@ -108,7 +108,7 @@ class Config { } /** - * @brief Removes a key from the config + * Removes a key from the config * @param string $key key * * This function removes a key from the config.php. @@ -125,7 +125,7 @@ class Config { } /** - * @brief Loads the config file + * Loads the config file * * Reads the config file and saves it to the cache */ @@ -153,7 +153,7 @@ class Config { } /** - * @brief Writes the config file + * Writes the config file * * Saves the config to the config file. * diff --git a/lib/private/connector/sabre/node.php b/lib/private/connector/sabre/node.php index ee38dfc8642..f124b754443 100644 --- a/lib/private/connector/sabre/node.php +++ b/lib/private/connector/sabre/node.php @@ -56,7 +56,7 @@ abstract class OC_Connector_Sabre_Node implements Sabre_DAV_INode, Sabre_DAV_IPr protected $info; /** - * @brief Sets up the node, expects a full path name + * Sets up the node, expects a full path name * @param \OC\Files\View $view * @param \OCP\Files\FileInfo $info */ @@ -71,7 +71,7 @@ abstract class OC_Connector_Sabre_Node implements Sabre_DAV_INode, Sabre_DAV_IPr } /** - * @brief Returns the name of the node + * Returns the name of the node * @return string */ public function getName() { @@ -79,7 +79,7 @@ abstract class OC_Connector_Sabre_Node implements Sabre_DAV_INode, Sabre_DAV_IPr } /** - * @brief Renames the node + * Renames the node * @param string $name The new name * @throws Sabre_DAV_Exception_BadRequest * @throws Sabre_DAV_Exception_Forbidden @@ -116,7 +116,7 @@ abstract class OC_Connector_Sabre_Node implements Sabre_DAV_INode, Sabre_DAV_IPr } /** - * @brief Returns the last modification time, as a unix timestamp + * Returns the last modification time, as a unix timestamp * @return int timestamp as integer */ public function getLastModified() { @@ -138,7 +138,7 @@ abstract class OC_Connector_Sabre_Node implements Sabre_DAV_INode, Sabre_DAV_IPr } /** - * @brief Updates properties on this node, + * Updates properties on this node, * @see Sabre_DAV_IProperties::updateProperties * @param array $properties * @return boolean @@ -188,7 +188,7 @@ abstract class OC_Connector_Sabre_Node implements Sabre_DAV_INode, Sabre_DAV_IPr } /** - * @brief Returns a list of properties for this nodes.; + * Returns a list of properties for this nodes.; * @param array $properties * @return array * @note The properties list is a list of propertynames the client diff --git a/lib/private/davclient.php b/lib/private/davclient.php index 916dc11d17a..a7bf0486519 100644 --- a/lib/private/davclient.php +++ b/lib/private/davclient.php @@ -32,7 +32,7 @@ class OC_DAVClient extends \Sabre_DAV_Client { protected $verifyHost; /** - * @brief Sets the request timeout or 0 to disable timeout. + * Sets the request timeout or 0 to disable timeout. * @param integer $timeout in seconds or 0 to disable */ public function setRequestTimeout($timeout) { @@ -40,7 +40,7 @@ class OC_DAVClient extends \Sabre_DAV_Client { } /** - * @brief Sets the CURLOPT_SSL_VERIFYHOST setting + * Sets the CURLOPT_SSL_VERIFYHOST setting * @param integer $value value to set CURLOPT_SSL_VERIFYHOST to */ public function setVerifyHost($value) { diff --git a/lib/private/db.php b/lib/private/db.php index 52bf570d1d0..fd512019213 100644 --- a/lib/private/db.php +++ b/lib/private/db.php @@ -50,7 +50,7 @@ class OC_DB { static private $type=null; /** - * @brief connects to the database + * connects to the database * @return boolean|null true if connection can be established or false on error * * Connects to the database as specified in config.php @@ -190,7 +190,7 @@ class OC_DB { } /** - * @brief Prepare a SQL query + * Prepare a SQL query * @param string $query Query string * @param int $limit * @param int $offset @@ -202,12 +202,12 @@ class OC_DB { */ static public function prepare( $query , $limit = null, $offset = null, $isManipulation = null) { self::connect(); - + if ($isManipulation === null) { //try to guess, so we return the number of rows on manipulations $isManipulation = self::isManipulation($query); } - + // return the result try { $result = self::$connection->prepare($query, $limit, $offset); @@ -222,7 +222,7 @@ class OC_DB { /** * tries to guess the type of statement based on the first 10 characters * the current check allows some whitespace but does not work with IF EXISTS or other more complex statements - * + * * @param string $sql * @return bool */ @@ -245,9 +245,9 @@ class OC_DB { } return false; } - + /** - * @brief execute a prepared statement, on error write log and throw exception + * execute a prepared statement, on error write log and throw exception * @param mixed $stmt OC_DB_StatementWrapper, * an array with 'sql' and optionally 'limit' and 'offset' keys * .. or a simple sql query string @@ -296,7 +296,7 @@ class OC_DB { } /** - * @brief gets last value of autoincrement + * gets last value of autoincrement * @param string $table The optional table name (will replace *PREFIX*) and add sequence suffix * @return string id * @throws DatabaseException @@ -312,7 +312,7 @@ class OC_DB { } /** - * @brief Insert a row if a matching row doesn't exists. + * Insert a row if a matching row doesn't exists. * @param string $table The table to insert into in the form '*PREFIX*tableName' * @param array $input An array of fieldname/value pairs * @return boolean number of updated rows @@ -339,7 +339,7 @@ class OC_DB { } /** - * @brief saves database schema to xml file + * saves database schema to xml file * @param string $file name of file * @param int $mode * @return bool @@ -352,7 +352,7 @@ class OC_DB { } /** - * @brief Creates tables from XML file + * Creates tables from XML file * @param string $file file to read structure from * @return bool * @@ -365,7 +365,7 @@ class OC_DB { } /** - * @brief update the database schema + * update the database schema * @param string $file file to read structure from * @throws Exception * @return string|boolean @@ -382,7 +382,7 @@ class OC_DB { } /** - * @brief drop a table + * drop a table * @param string $tableName the table to drop */ public static function dropTable($tableName) { @@ -400,7 +400,7 @@ class OC_DB { } /** - * @brief replaces the ownCloud tables with a new set + * replaces the ownCloud tables with a new set * @param string $file path to the MDB2 xml db export file */ public static function replaceDB( $file ) { diff --git a/lib/private/db/adapter.php b/lib/private/db/adapter.php index 6b31f37dd98..975b9432286 100644 --- a/lib/private/db/adapter.php +++ b/lib/private/db/adapter.php @@ -40,7 +40,7 @@ class Adapter { } /** - * @brief insert the @input values when they do not exist yet + * insert the @input values when they do not exist yet * @param string $table name * @param array $input key->value pairs * @return int count of inserted rows diff --git a/lib/private/db/connection.php b/lib/private/db/connection.php index 2bd7b093020..b7981fcd691 100644 --- a/lib/private/db/connection.php +++ b/lib/private/db/connection.php @@ -152,7 +152,7 @@ class Connection extends \Doctrine\DBAL\Connection { } /** - * @brief Insert a row if a matching row doesn't exists. + * Insert a row if a matching row doesn't exists. * @param string $table. The table to insert into in the form '*PREFIX*tableName' * @param array $input. An array of fieldname/value pairs * @return bool The return value from execute() diff --git a/lib/private/db/mdb2schemamanager.php b/lib/private/db/mdb2schemamanager.php index d98197445e9..1e90c8bda5c 100644 --- a/lib/private/db/mdb2schemamanager.php +++ b/lib/private/db/mdb2schemamanager.php @@ -24,7 +24,7 @@ class MDB2SchemaManager { } /** - * @brief saves database scheme to xml file + * saves database scheme to xml file * @param string $file name of file * @param int|string $mode * @return bool @@ -38,7 +38,7 @@ class MDB2SchemaManager { } /** - * @brief Creates tables from XML file + * Creates tables from XML file * @param string $file file to read structure from * @return bool * @@ -51,7 +51,7 @@ class MDB2SchemaManager { } /** - * @brief update the database scheme + * update the database scheme * @param string $file file to read structure from * @return string|boolean */ @@ -86,7 +86,7 @@ class MDB2SchemaManager { $column->oldColumnName = $platform->quoteIdentifier($column->oldColumnName); } } - + if ($generateSql) { return $this->generateChangeScript($schemaDiff); } @@ -95,7 +95,7 @@ class MDB2SchemaManager { } /** - * @brief drop a table + * drop a table * @param string $tableName the table to drop */ public function dropTable($tableName) { @@ -125,7 +125,7 @@ class MDB2SchemaManager { } /** - * @brief replaces the ownCloud tables with a new set + * replaces the ownCloud tables with a new set * @param string $file path to the MDB2 xml db export file */ public function replaceDB( $file ) { diff --git a/lib/private/files/cache/scanner.php b/lib/private/files/cache/scanner.php index 51454a71458..b3ab94f4599 100644 --- a/lib/private/files/cache/scanner.php +++ b/lib/private/files/cache/scanner.php @@ -270,7 +270,7 @@ class Scanner extends BasicEmitter { } /** - * @brief check if the file should be ignored when scanning + * check if the file should be ignored when scanning * NOTE: files with a '.part' extension are ignored as well! * prevents unfinished put requests to be scanned * @param string $file diff --git a/lib/private/files/cache/updater.php b/lib/private/files/cache/updater.php index 95f77a81fa2..f6feb6624b2 100644 --- a/lib/private/files/cache/updater.php +++ b/lib/private/files/cache/updater.php @@ -108,7 +108,7 @@ class Updater { } /** - * @brief get file owner and path + * get file owner and path * @param string $filename * @return string[] with the oweners uid and the owners path */ diff --git a/lib/private/files/filesystem.php b/lib/private/files/filesystem.php index 22d15840c32..ad7213d2368 100644 --- a/lib/private/files/filesystem.php +++ b/lib/private/files/filesystem.php @@ -384,7 +384,7 @@ class Filesystem { } /** - * @brief get the relative path of the root data directory for the current user + * get the relative path of the root data directory for the current user * @return string * * Returns path like /admin/files @@ -502,7 +502,7 @@ class Filesystem { } /** - * @brief check if the directory should be ignored when scanning + * check if the directory should be ignored when scanning * NOTE: the special directories . and .. would cause never ending recursion * @param String $dir * @return boolean @@ -662,7 +662,7 @@ class Filesystem { } /** - * @brief Fix common problems with a file path + * Fix common problems with a file path * @param string $path * @param bool $stripTrailingSlash * @return string diff --git a/lib/private/files/storage/home.php b/lib/private/files/storage/home.php index 1c2a682f197..f66096f6d9c 100644 --- a/lib/private/files/storage/home.php +++ b/lib/private/files/storage/home.php @@ -23,7 +23,7 @@ class Home extends Local { protected $user; /** - * @brief Construct a Home storage instance + * Construct a Home storage instance * @param array $arguments array with "user" containing the * storage owner and "legacy" containing "true" if the storage is * a legacy storage with "local::" URL instead of the new "home::" one. @@ -57,7 +57,7 @@ class Home extends Local { } /** - * @brief Returns the owner of this home storage + * Returns the owner of this home storage * @return \OC\User\User owner of this home storage */ public function getUser() { diff --git a/lib/private/files/view.php b/lib/private/files/view.php index 3b99bd12b8a..940f31fe420 100644 --- a/lib/private/files/view.php +++ b/lib/private/files/view.php @@ -673,7 +673,7 @@ class View { } /** - * @brief abstraction layer for basic filesystem functions: wrapper for \OC\Files\Storage\Storage + * abstraction layer for basic filesystem functions: wrapper for \OC\Files\Storage\Storage * @param string $operation * @param string $path * @param array $hooks (optional) diff --git a/lib/private/geo.php b/lib/private/geo.php index a0ad2b799ab..bd9253bc0dd 100644 --- a/lib/private/geo.php +++ b/lib/private/geo.php @@ -7,7 +7,7 @@ */ class OC_Geo{ /** - * @brief returns the closest timezone to coordinates + * returns the closest timezone to coordinates * @param float $latitude * @param float $longitude * @return mixed Closest timezone diff --git a/lib/private/group.php b/lib/private/group.php index 845b3655bab..8dc38129205 100644 --- a/lib/private/group.php +++ b/lib/private/group.php @@ -57,7 +57,7 @@ class OC_Group { } /** - * @brief set the group backend + * set the group backend * @param \OC_Group_Backend $backend The backend to use for user managment * @return bool */ @@ -74,7 +74,7 @@ class OC_Group { } /** - * @brief Try to create a new group + * Try to create a new group * @param string $gid The name of the group to create * @return bool * @@ -93,7 +93,7 @@ class OC_Group { } /** - * @brief delete a group + * delete a group * @param string $gid gid of the group to delete * @return bool * @@ -118,7 +118,7 @@ class OC_Group { } /** - * @brief is user in group? + * is user in group? * @param string $uid uid of the user * @param string $gid gid of the group * @return bool @@ -135,7 +135,7 @@ class OC_Group { } /** - * @brief Add a user to a group + * Add a user to a group * @param string $uid Name of the user to add to group * @param string $gid Name of the group in which add the user * @return bool @@ -156,7 +156,7 @@ class OC_Group { } /** - * @brief Removes a user from a group + * Removes a user from a group * @param string $uid Name of the user to remove from group * @param string $gid Name of the group from which remove the user * @return bool @@ -177,7 +177,7 @@ class OC_Group { } /** - * @brief Get all groups a user belongs to + * Get all groups a user belongs to * @param string $uid Name of the user * @return array an array of group names * @@ -199,7 +199,7 @@ class OC_Group { } /** - * @brief get a list of all groups + * get a list of all groups * @param string $search * @param int|null $limit * @param int|null $offset @@ -227,7 +227,7 @@ class OC_Group { } /** - * @brief get a list of all users in a group + * get a list of all users in a group * @param string $gid * @param string $search * @param int $limit @@ -249,7 +249,7 @@ class OC_Group { } /** - * @brief get a list of all users in several groups + * get a list of all users in several groups * @param string[] $gids * @param string $search * @param int $limit @@ -266,7 +266,7 @@ class OC_Group { } /** - * @brief get a list of all display names in a group + * get a list of all display names in a group * @param string $gid * @param string $search * @param int $limit @@ -278,7 +278,7 @@ class OC_Group { } /** - * @brief get a list of all display names in several groups + * get a list of all display names in several groups * @param array $gids * @param string $search * @param int $limit diff --git a/lib/private/group/backend.php b/lib/private/group/backend.php index 38522d0c43c..ab694268bb3 100644 --- a/lib/private/group/backend.php +++ b/lib/private/group/backend.php @@ -49,7 +49,7 @@ abstract class OC_Group_Backend implements OC_Group_Interface { ); /** - * @brief Get all supported actions + * Get all supported actions * @return int bitwise-or'ed actions * * Returns the supported actions as int to be @@ -67,7 +67,7 @@ abstract class OC_Group_Backend implements OC_Group_Interface { } /** - * @brief Check if backend implements actions + * Check if backend implements actions * @param int $actions bitwise-or'ed actions * @return bool * @@ -79,7 +79,7 @@ abstract class OC_Group_Backend implements OC_Group_Interface { } /** - * @brief is user in group? + * is user in group? * @param string $uid uid of the user * @param string $gid gid of the group * @return bool @@ -91,7 +91,7 @@ abstract class OC_Group_Backend implements OC_Group_Interface { } /** - * @brief Get all groups a user belongs to + * Get all groups a user belongs to * @param string $uid Name of the user * @return array an array of group names * @@ -103,7 +103,7 @@ abstract class OC_Group_Backend implements OC_Group_Interface { } /** - * @brief get a list of all groups + * get a list of all groups * @param string $search * @param int $limit * @param int $offset @@ -126,7 +126,7 @@ abstract class OC_Group_Backend implements OC_Group_Interface { } /** - * @brief get a list of all users in a group + * get a list of all users in a group * @param string $gid * @param string $search * @param int $limit diff --git a/lib/private/group/database.php b/lib/private/group/database.php index 91baa3140cc..baaf2cf2739 100644 --- a/lib/private/group/database.php +++ b/lib/private/group/database.php @@ -43,7 +43,7 @@ class OC_Group_Database extends OC_Group_Backend { /** - * @brief Try to create a new group + * Try to create a new group * @param string $gid The name of the group to create * @return bool * @@ -69,7 +69,7 @@ class OC_Group_Database extends OC_Group_Backend { } /** - * @brief delete a group + * delete a group * @param string $gid gid of the group to delete * @return bool * @@ -88,7 +88,7 @@ class OC_Group_Database extends OC_Group_Backend { } /** - * @brief is user in group? + * is user in group? * @param string $uid uid of the user * @param string $gid gid of the group * @return bool @@ -104,7 +104,7 @@ class OC_Group_Database extends OC_Group_Backend { } /** - * @brief Add a user to a group + * Add a user to a group * @param string $uid Name of the user to add to group * @param string $gid Name of the group in which add the user * @return bool @@ -123,7 +123,7 @@ class OC_Group_Database extends OC_Group_Backend { } /** - * @brief Removes a user from a group + * Removes a user from a group * @param string $uid Name of the user to remove from group * @param string $gid Name of the group from which remove the user * @return bool @@ -138,7 +138,7 @@ class OC_Group_Database extends OC_Group_Backend { } /** - * @brief Get all groups a user belongs to + * Get all groups a user belongs to * @param string $uid Name of the user * @return array an array of group names * @@ -159,7 +159,7 @@ class OC_Group_Database extends OC_Group_Backend { } /** - * @brief get a list of all groups + * get a list of all groups * @param string $search * @param int $limit * @param int $offset @@ -192,7 +192,7 @@ class OC_Group_Database extends OC_Group_Backend { } /** - * @brief get a list of all users in a group + * get a list of all users in a group * @param string $gid * @param string $search * @param int $limit @@ -212,7 +212,7 @@ class OC_Group_Database extends OC_Group_Backend { } /** - * @brief get the number of all users matching the search string in a group + * get the number of all users matching the search string in a group * @param string $gid * @param string $search * @return int|false diff --git a/lib/private/group/dummy.php b/lib/private/group/dummy.php index 75bab31a337..e48c6a0e266 100644 --- a/lib/private/group/dummy.php +++ b/lib/private/group/dummy.php @@ -27,7 +27,7 @@ class OC_Group_Dummy extends OC_Group_Backend { private $groups=array(); /** - * @brief Try to create a new group + * Try to create a new group * @param string $gid The name of the group to create * @return bool * @@ -44,7 +44,7 @@ class OC_Group_Dummy extends OC_Group_Backend { } /** - * @brief delete a group + * delete a group * @param string $gid gid of the group to delete * @return bool * @@ -60,7 +60,7 @@ class OC_Group_Dummy extends OC_Group_Backend { } /** - * @brief is user in group? + * is user in group? * @param string $uid uid of the user * @param string $gid gid of the group * @return bool @@ -76,7 +76,7 @@ class OC_Group_Dummy extends OC_Group_Backend { } /** - * @brief Add a user to a group + * Add a user to a group * @param string $uid Name of the user to add to group * @param string $gid Name of the group in which add the user * @return bool @@ -97,7 +97,7 @@ class OC_Group_Dummy extends OC_Group_Backend { } /** - * @brief Removes a user from a group + * Removes a user from a group * @param string $uid Name of the user to remove from group * @param string $gid Name of the group from which remove the user * @return bool @@ -117,7 +117,7 @@ class OC_Group_Dummy extends OC_Group_Backend { } /** - * @brief Get all groups a user belongs to + * Get all groups a user belongs to * @param string $uid Name of the user * @return array an array of group names * @@ -136,7 +136,7 @@ class OC_Group_Dummy extends OC_Group_Backend { } /** - * @brief Get a list of all groups + * Get a list of all groups * @param string $search * @param int $limit * @param int $offset @@ -147,7 +147,7 @@ class OC_Group_Dummy extends OC_Group_Backend { } /** - * @brief Get a list of all users in a group + * Get a list of all users in a group * @param string $gid * @param string $search * @param int $limit @@ -163,7 +163,7 @@ class OC_Group_Dummy extends OC_Group_Backend { } /** - * @brief get the number of all users in a group + * get the number of all users in a group * @param string $gid * @param string $search * @param int $limit diff --git a/lib/private/group/example.php b/lib/private/group/example.php index 76c9ce2433d..8c1e22866f2 100644 --- a/lib/private/group/example.php +++ b/lib/private/group/example.php @@ -27,7 +27,7 @@ */ abstract class OC_Group_Example { /** - * @brief Try to create a new group + * Try to create a new group * @param string $gid The name of the group to create * @return bool * @@ -37,7 +37,7 @@ abstract class OC_Group_Example { abstract public static function createGroup($gid); /** - * @brief delete a group + * delete a group * @param string $gid gid of the group to delete * @return bool * @@ -46,7 +46,7 @@ abstract class OC_Group_Example { abstract public static function deleteGroup($gid); /** - * @brief is user in group? + * is user in group? * @param string $uid uid of the user * @param string $gid gid of the group * @return bool @@ -56,7 +56,7 @@ abstract class OC_Group_Example { abstract public static function inGroup($uid, $gid); /** - * @brief Add a user to a group + * Add a user to a group * @param string $uid Name of the user to add to group * @param string $gid Name of the group in which add the user * @return bool @@ -66,7 +66,7 @@ abstract class OC_Group_Example { abstract public static function addToGroup($uid, $gid); /** - * @brief Removes a user from a group + * Removes a user from a group * @param string $uid Name of the user to remove from group * @param string $gid Name of the group from which remove the user * @return bool @@ -76,7 +76,7 @@ abstract class OC_Group_Example { abstract public static function removeFromGroup($uid, $gid); /** - * @brief Get all groups a user belongs to + * Get all groups a user belongs to * @param string $uid Name of the user * @return array an array of group names * @@ -86,7 +86,7 @@ abstract class OC_Group_Example { abstract public static function getUserGroups($uid); /** - * @brief get a list of all groups + * get a list of all groups * @param string $search * @param int $limit * @param int $offset @@ -95,14 +95,14 @@ abstract class OC_Group_Example { abstract public static function getGroups($search = '', $limit = -1, $offset = 0); /** - * @brief Check if a group exists + * Check if a group exists * @param string $gid * @return bool */ abstract public function groupExists($gid); /** - * @brief get a list of all users in a group + * get a list of all users in a group * @param string $gid * @param string $search * @param int $limit diff --git a/lib/private/group/group.php b/lib/private/group/group.php index 69641854dc5..3e245ab6bbe 100644 --- a/lib/private/group/group.php +++ b/lib/private/group/group.php @@ -244,7 +244,7 @@ class Group { } /** - * @brief returns all the Users from an array that really exists + * returns all the Users from an array that really exists * @param string[] $userIds an array containing user IDs * @return \OC\User\User[] an Array with the userId as Key and \OC\User\User as value */ diff --git a/lib/private/group/interface.php b/lib/private/group/interface.php index 74d288d42c0..ee5c2d635d6 100644 --- a/lib/private/group/interface.php +++ b/lib/private/group/interface.php @@ -23,7 +23,7 @@ interface OC_Group_Interface { /** - * @brief Check if backend implements actions + * Check if backend implements actions * @param int $actions bitwise-or'ed actions * @return boolean * @@ -33,7 +33,7 @@ interface OC_Group_Interface { public function implementsActions($actions); /** - * @brief is user in group? + * is user in group? * @param string $uid uid of the user * @param string $gid gid of the group * @return bool @@ -43,7 +43,7 @@ interface OC_Group_Interface { public function inGroup($uid, $gid); /** - * @brief Get all groups a user belongs to + * Get all groups a user belongs to * @param string $uid Name of the user * @return array an array of group names * @@ -53,7 +53,7 @@ interface OC_Group_Interface { public function getUserGroups($uid); /** - * @brief get a list of all groups + * get a list of all groups * @param string $search * @param int $limit * @param int $offset @@ -71,7 +71,7 @@ interface OC_Group_Interface { public function groupExists($gid); /** - * @brief get a list of all users in a group + * get a list of all users in a group * @param string $gid * @param string $search * @param int $limit diff --git a/lib/private/group/manager.php b/lib/private/group/manager.php index 707009fb3d4..dae6443e9d4 100644 --- a/lib/private/group/manager.php +++ b/lib/private/group/manager.php @@ -184,7 +184,7 @@ class Manager extends PublicEmitter { } /** - * @brief get a list of all display names in a group + * get a list of all display names in a group * @param string $gid * @param string $search * @param int $limit diff --git a/lib/private/helper.php b/lib/private/helper.php index 12d82f6fb45..4ad792dfb13 100644 --- a/lib/private/helper.php +++ b/lib/private/helper.php @@ -31,7 +31,7 @@ class OC_Helper { private static $templateManager; /** - * @brief Creates an url using a defined route + * Creates an url using a defined route * @param string $route * @param array $parameters * @return @@ -45,7 +45,7 @@ class OC_Helper { } /** - * @brief Creates an url + * Creates an url * @param string $app app * @param string $file file * @param array $args array with param=>value, will be appended to the returned url @@ -68,7 +68,7 @@ class OC_Helper { } /** - * @brief Creates an absolute url + * Creates an absolute url * @param string $app app * @param string $file file * @param array $args array with param=>value, will be appended to the returned url @@ -84,7 +84,7 @@ class OC_Helper { } /** - * @brief Makes an $url absolute + * Makes an $url absolute * @param string $url the url * @return string the absolute url * @@ -95,7 +95,7 @@ class OC_Helper { } /** - * @brief Creates an url for remote use + * Creates an url for remote use * @param string $service id * @return string the url * @@ -106,7 +106,7 @@ class OC_Helper { } /** - * @brief Creates an absolute url for remote use + * Creates an absolute url for remote use * @param string $service id * @param bool $add_slash * @return string the url @@ -121,7 +121,7 @@ class OC_Helper { } /** - * @brief Creates an absolute url for public use + * Creates an absolute url for public use * @param string $service id * @param bool $add_slash * @return string the url @@ -138,7 +138,7 @@ class OC_Helper { } /** - * @brief Creates path to an image + * Creates path to an image * @param string $app app * @param string $image image name * @return string the url @@ -150,7 +150,7 @@ class OC_Helper { } /** - * @brief get path to icon of file type + * get path to icon of file type * @param string $mimetype mimetype * @return string the url * @@ -264,7 +264,7 @@ class OC_Helper { } /** - * @brief get path to preview of file + * get path to preview of file * @param string $path path * @return string the url * @@ -279,7 +279,7 @@ class OC_Helper { } /** - * @brief Make a human file size + * Make a human file size * @param int $bytes file size in bytes * @return string a human readable file size * @@ -314,7 +314,7 @@ class OC_Helper { } /** - * @brief Make a php file size + * Make a php file size * @param int $bytes file size in bytes * @return string a php parseable file size * @@ -340,7 +340,7 @@ class OC_Helper { } /** - * @brief Make a computer file size + * Make a computer file size * @param string $str file size in human readable format * @return int a file size in bytes * @@ -377,7 +377,7 @@ class OC_Helper { } /** - * @brief Recursive copying of folders + * Recursive copying of folders * @param string $src source folder * @param string $dest target folder * @@ -399,7 +399,7 @@ class OC_Helper { } /** - * @brief Recursive deletion of folders + * Recursive deletion of folders * @param string $dir path to the folder * @return bool */ @@ -485,7 +485,7 @@ class OC_Helper { } /** - * @brief Checks $_REQUEST contains a var for the $s key. If so, returns the html-escaped value of this var; otherwise returns the default value provided by $d. + * Checks $_REQUEST contains a var for the $s key. If so, returns the html-escaped value of this var; otherwise returns the default value provided by $d. * @param string $s name of the var to escape, if set. * @param string $d default value. * @return string the print-safe value. @@ -726,7 +726,7 @@ class OC_Helper { } /** - * @brief Checks if $sub is a subdirectory of $parent + * Checks if $sub is a subdirectory of $parent * * @param string $sub * @param string $parent @@ -752,7 +752,7 @@ class OC_Helper { } /** - * @brief Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is. + * Returns an array with all keys from input lowercased or uppercased. Numbered indices are left as is. * * @param array $input The array to work on * @param int $case Either MB_CASE_UPPER or MB_CASE_LOWER (default) @@ -773,7 +773,7 @@ class OC_Helper { } /** - * @brief replaces a copy of string delimited by the start and (optionally) length parameters with the string given in replacement. + * replaces a copy of string delimited by the start and (optionally) length parameters with the string given in replacement. * * @param string $string * @param string $replacement The replacement string. @@ -794,7 +794,7 @@ class OC_Helper { } /** - * @brief Replace all occurrences of the search string with the replacement string + * Replace all occurrences of the search string with the replacement string * * @param string $search The value being searched for, otherwise known as the needle. * @param string $replace The replacement @@ -816,7 +816,7 @@ class OC_Helper { } /** - * @brief performs a search in a nested array + * performs a search in a nested array * @param array $haystack the array to be searched * @param string $needle the search string * @param string $index optional, only search this key name @@ -858,7 +858,7 @@ class OC_Helper { } /** - * @brief calculates the maximum upload size respecting system settings, free space and user quota + * calculates the maximum upload size respecting system settings, free space and user quota * * @param string $dir the current folder where the user currently operates * @param int $freeSpace the number of bytes free on the storage holding $dir, if not set this will be received from the storage directly @@ -873,7 +873,7 @@ class OC_Helper { /** * Calculate free space left within user quota - * + * * @param string $dir the current folder where the user currently operates * @return int number of bytes representing */ diff --git a/lib/private/hook.php b/lib/private/hook.php index b715db2d16c..30e22847c7f 100644 --- a/lib/private/hook.php +++ b/lib/private/hook.php @@ -8,7 +8,7 @@ class OC_Hook{ static private $registered = array(); /** - * @brief connects a function to a hook + * connects a function to a hook * @param string $signalclass class name of emitter * @param string $signalname name of signal * @param string $slotclass class name of slot @@ -42,7 +42,7 @@ class OC_Hook{ } /** - * @brief emits a signal + * emits a signal * @param string $signalclass class name of emitter * @param string $signalname name of signal * @param mixed $params default: array() array with additional data diff --git a/lib/private/image.php b/lib/private/image.php index 341bfaaf818..5331c399159 100644 --- a/lib/private/image.php +++ b/lib/private/image.php @@ -33,7 +33,7 @@ class OC_Image { private $fileInfo; /** - * @brief Get mime type for an image file. + * Get mime type for an image file. * @param string|null $filePath The path to a local image file. * @return string The mime type if the it could be determined, otherwise an empty string. */ @@ -48,7 +48,7 @@ class OC_Image { } /** - * @brief Constructor. + * Constructor. * @param resource|string $imageRef The path to a local file, a base64 encoded string or a resource created by * an imagecreate* function. * @return \OC_Image False on error @@ -70,7 +70,7 @@ class OC_Image { } /** - * @brief Determine whether the object contains an image resource. + * Determine whether the object contains an image resource. * @return bool */ public function valid() { // apparently you can't name a method 'empty'... @@ -78,7 +78,7 @@ class OC_Image { } /** - * @brief Returns the MIME type of the image or an empty string if no image is loaded. + * Returns the MIME type of the image or an empty string if no image is loaded. * @return string */ public function mimeType() { @@ -86,7 +86,7 @@ class OC_Image { } /** - * @brief Returns the width of the image or -1 if no image is loaded. + * Returns the width of the image or -1 if no image is loaded. * @return int */ public function width() { @@ -94,7 +94,7 @@ class OC_Image { } /** - * @brief Returns the height of the image or -1 if no image is loaded. + * Returns the height of the image or -1 if no image is loaded. * @return int */ public function height() { @@ -102,7 +102,7 @@ class OC_Image { } /** - * @brief Returns the width when the image orientation is top-left. + * Returns the width when the image orientation is top-left. * @return int */ public function widthTopLeft() { @@ -125,7 +125,7 @@ class OC_Image { } /** - * @brief Returns the height when the image orientation is top-left. + * Returns the height when the image orientation is top-left. * @return int */ public function heightTopLeft() { @@ -148,7 +148,7 @@ class OC_Image { } /** - * @brief Outputs the image. + * Outputs the image. * @param string $mimeType * @return bool */ @@ -161,7 +161,7 @@ class OC_Image { } /** - * @brief Saves the image. + * Saves the image. * @param string $filePath * @param string $mimeType * @return bool @@ -181,7 +181,7 @@ class OC_Image { } /** - * @brief Outputs/saves the image. + * Outputs/saves the image. * @param string $filePath * @param string $mimeType * @return bool @@ -259,7 +259,7 @@ class OC_Image { } /** - * @brief Prints the image when called as $image(). + * Prints the image when called as $image(). */ public function __invoke() { return $this->show(); @@ -307,7 +307,7 @@ class OC_Image { /** * (I'm open for suggestions on better method name ;) - * @brief Get the orientation based on EXIF data. + * Get the orientation based on EXIF data. * @return int The orientation or -1 if no EXIF data is available. */ public function getOrientation() { @@ -335,7 +335,7 @@ class OC_Image { /** * (I'm open for suggestions on better method name ;) - * @brief Fixes orientation based on EXIF data. + * Fixes orientation based on EXIF data. * @return bool. */ public function fixOrientation() { @@ -396,7 +396,7 @@ class OC_Image { } /** - * @brief Loads an image from a local file, a base64 encoded string or a resource created by an imagecreate* function. + * Loads an image from a local file, a base64 encoded string or a resource created by an imagecreate* function. * @param resource|string $imageRef The path to a local file, a base64 encoded string or a resource created by an imagecreate* function or a file resource (file handle ). * @return resource|false An image resource or false on error */ @@ -421,7 +421,7 @@ class OC_Image { } /** - * @brief Loads an image from an open file handle. + * Loads an image from an open file handle. * It is the responsibility of the caller to position the pointer at the correct place and to close the handle again. * @param resource $handle * @return resource|false An image resource or false on error @@ -435,7 +435,7 @@ class OC_Image { } /** - * @brief Loads an image from a local file. + * Loads an image from a local file. * @param bool|string $imagePath The path to a local file. * @return bool|resource An image resource or false on error */ @@ -536,7 +536,7 @@ class OC_Image { } /** - * @brief Loads an image from a string of data. + * Loads an image from a string of data. * @param string $str A string of image data as read from a file. * @return bool|resource An image resource or false on error */ @@ -561,7 +561,7 @@ class OC_Image { } /** - * @brief Loads an image from a base64 encoded string. + * Loads an image from a base64 encoded string. * @param string $str A string base64 encoded string of image data. * @return bool|resource An image resource or false on error */ @@ -729,7 +729,7 @@ class OC_Image { } /** - * @brief Resizes the image preserving ratio. + * Resizes the image preserving ratio. * @param integer $maxSize The maximum size of either the width or height. * @return bool */ @@ -793,7 +793,7 @@ class OC_Image { } /** - * @brief Crops the image to the middle square. If the image is already square it just returns. + * Crops the image to the middle square. If the image is already square it just returns. * @param int $size maximum size for the result (optional) * @return bool for success or failure */ @@ -852,7 +852,7 @@ class OC_Image { } /** - * @brief Crops the image from point $x$y with dimension $wx$h. + * Crops the image from point $x$y with dimension $wx$h. * @param int $x Horizontal position * @param int $y Vertical position * @param int $w Width @@ -882,7 +882,7 @@ class OC_Image { } /** - * @brief Resizes the image to fit within a boundry while preserving ratio. + * Resizes the image to fit within a boundry while preserving ratio. * @param integer $maxWidth * @param integer $maxHeight * @return bool diff --git a/lib/private/installer.php b/lib/private/installer.php index 9417c32bc89..667c05c9c16 100644 --- a/lib/private/installer.php +++ b/lib/private/installer.php @@ -52,7 +52,7 @@ class OC_Installer{ * It is the task of oc_app_install to create the tables and do whatever is * needed to get the app working. * - * @brief Installs an app + * Installs an app * @param array $data with all information * @throws \Exception * @return integer @@ -219,7 +219,7 @@ class OC_Installer{ } /** - * @brief checks whether or not an app is installed + * checks whether or not an app is installed * @param string $app app * @return bool * @@ -235,7 +235,7 @@ class OC_Installer{ } /** - * @brief Update an application + * Update an application * * This function installs an app. All information needed are passed in the * associative array $data. @@ -268,7 +268,7 @@ class OC_Installer{ } /** - * @brief Check if an update for the app is available + * Check if an update for the app is available * @return string|false false or the version number of the update * * The function will check if an update for a version is available @@ -295,7 +295,7 @@ class OC_Installer{ } /** - * @brief Check if app is already downloaded + * Check if app is already downloaded * @param string $name name of the application to remove * @return boolean * @@ -311,7 +311,7 @@ class OC_Installer{ } /** - * @brief Removes an app + * Removes an app * @param string $name name of the application to remove * @param array $options options * @return boolean|null @@ -364,7 +364,7 @@ class OC_Installer{ } /** - * @brief Installs shipped apps + * Installs shipped apps * * This function installs all apps found in the 'apps' directory that should be enabled by default; */ diff --git a/lib/private/l10n.php b/lib/private/l10n.php index 40eeb98d6bb..3e44be88150 100644 --- a/lib/private/l10n.php +++ b/lib/private/l10n.php @@ -86,7 +86,7 @@ class OC_L10N implements \OCP\IL10N { } /** - * @brief The constructor + * The constructor * @param string $app app requesting l10n * @param string $lang default: null Language * @@ -176,7 +176,7 @@ class OC_L10N implements \OCP\IL10N { } /** - * @brief Creates a function that The constructor + * Creates a function that The constructor * * If language is not set, the constructor tries to find the right * language. @@ -235,7 +235,7 @@ class OC_L10N implements \OCP\IL10N { } /** - * @brief Translating + * Translating * @param string $text The text we need a translation for * @param array $parameters default:array() Parameters for sprintf * @return \OC_L10N_String Translation or the same text @@ -248,7 +248,7 @@ class OC_L10N implements \OCP\IL10N { } /** - * @brief Translating + * Translating * @param string $text_singular the string to translate for exactly one object * @param string $text_plural the string to translate for n objects * @param integer $count Number of objects @@ -277,7 +277,7 @@ class OC_L10N implements \OCP\IL10N { } /** - * @brief getTranslations + * getTranslations * @return array Fetch all translations * * Returns an associative array with all translations @@ -288,7 +288,7 @@ class OC_L10N implements \OCP\IL10N { } /** - * @brief getPluralFormString + * getPluralFormString * @return string containing the gettext "Plural-Forms"-string * * Returns a string like "nplurals=2; plural=(n != 1);" @@ -299,7 +299,7 @@ class OC_L10N implements \OCP\IL10N { } /** - * @brief getPluralFormFunction + * getPluralFormFunction * @return string the plural form function * * returned function accepts the argument $n @@ -313,7 +313,7 @@ class OC_L10N implements \OCP\IL10N { } /** - * @brief get localizations + * get localizations * @return array Fetch all localizations * * Returns an associative array with all localizations @@ -324,7 +324,7 @@ class OC_L10N implements \OCP\IL10N { } /** - * @brief Localization + * Localization * @param string $type Type of localization * @param array|int|string $data parameters for this localization * @return String or false @@ -379,7 +379,7 @@ class OC_L10N implements \OCP\IL10N { } /** - * @brief Choose a language + * Choose a language * @param array $text Associative Array with possible strings * @return String * @@ -403,9 +403,9 @@ class OC_L10N implements \OCP\IL10N { /** - * @brief find the best language + * find the best language * @param array|string $app details below - * @returns string language + * string language * * If $app is an array, ownCloud assumes that these are the available * languages. Otherwise ownCloud tries to find the files in the l10n @@ -416,10 +416,10 @@ class OC_L10N implements \OCP\IL10N { public function getLanguageCode($app=null) { return self::findLanguage($app); } - + /** - * @brief find the best language + * find the best language * @param array|string $app details below * @return string language * @@ -492,7 +492,7 @@ class OC_L10N implements \OCP\IL10N { } /** - * @brief find the l10n directory + * find the l10n directory * @param string $app App that needs to be translated * @return directory */ @@ -512,7 +512,7 @@ class OC_L10N implements \OCP\IL10N { } /** - * @brief find all available languages for an app + * find all available languages for an app * @param string $app App that needs to be translated * @return array an array of available languages */ diff --git a/lib/private/legacy/appconfig.php b/lib/private/legacy/appconfig.php index 209f42ffe38..4634f2c695d 100644 --- a/lib/private/legacy/appconfig.php +++ b/lib/private/legacy/appconfig.php @@ -34,7 +34,7 @@ class OC_Appconfig { } /** - * @brief Get all apps using the config + * Get all apps using the config * @return array an array of app ids * * This function returns a list of all apps that have at least one @@ -45,7 +45,7 @@ class OC_Appconfig { } /** - * @brief Get the available keys for an app + * Get the available keys for an app * @param string $app the app we are looking for * @return array an array of key names * @@ -57,7 +57,7 @@ class OC_Appconfig { } /** - * @brief Gets the config value + * Gets the config value * @param string $app app * @param string $key key * @param string $default = null, default value if the key does not exist @@ -71,7 +71,7 @@ class OC_Appconfig { } /** - * @brief check if a key is set in the appconfig + * check if a key is set in the appconfig * @param string $app * @param string $key * @return bool @@ -81,7 +81,7 @@ class OC_Appconfig { } /** - * @brief sets a value in the appconfig + * sets a value in the appconfig * @param string $app app * @param string $key key * @param string $value value @@ -93,7 +93,7 @@ class OC_Appconfig { } /** - * @brief Deletes a key + * Deletes a key * @param string $app app * @param string $key key * @@ -104,7 +104,7 @@ class OC_Appconfig { } /** - * @brief Remove app from appconfig + * Remove app from appconfig * @param string $app app * * Removes all keys in appconfig belonging to the app. diff --git a/lib/private/legacy/config.php b/lib/private/legacy/config.php index 76a53d3f627..899c19532f0 100644 --- a/lib/private/legacy/config.php +++ b/lib/private/legacy/config.php @@ -50,7 +50,7 @@ class OC_Config { } /** - * @brief Lists all available config keys + * Lists all available config keys * @return array an array of key names * * This function returns all keys saved in config.php. Please note that it @@ -61,7 +61,7 @@ class OC_Config { } /** - * @brief Gets a value from config.php + * Gets a value from config.php * @param string $key key * @param mixed $default = null default value * @return mixed the value or $default @@ -74,7 +74,7 @@ class OC_Config { } /** - * @brief Sets a value + * Sets a value * @param string $key key * @param mixed $value value * @@ -86,7 +86,7 @@ class OC_Config { } /** - * @brief Removes a key from the config + * Removes a key from the config * @param string $key key * * This function removes a key from the config.php. diff --git a/lib/private/legacy/preferences.php b/lib/private/legacy/preferences.php index eed6730a529..71d0b749f43 100644 --- a/lib/private/legacy/preferences.php +++ b/lib/private/legacy/preferences.php @@ -28,7 +28,7 @@ OC_Preferences::$object = new \OC\Preferences(OC_DB::getConnection()); class OC_Preferences{ public static $object; /** - * @brief Get all users using the preferences + * Get all users using the preferences * @return array an array of user ids * * This function returns a list of all users that have at least one entry @@ -39,7 +39,7 @@ class OC_Preferences{ } /** - * @brief Get all apps of a user + * Get all apps of a user * @param string $user user * @return integer[] with app ids * @@ -51,7 +51,7 @@ class OC_Preferences{ } /** - * @brief Get the available keys for an app + * Get the available keys for an app * @param string $user user * @param string $app the app we are looking for * @return array an array of key names @@ -64,7 +64,7 @@ class OC_Preferences{ } /** - * @brief Gets the preference + * Gets the preference * @param string $user user * @param string $app app * @param string $key key @@ -79,7 +79,7 @@ class OC_Preferences{ } /** - * @brief sets a value in the preferences + * sets a value in the preferences * @param string $user user * @param string $app app * @param string $key key @@ -95,7 +95,7 @@ class OC_Preferences{ } /** - * @brief Deletes a key + * Deletes a key * @param string $user user * @param string $app app * @param string $key key @@ -108,7 +108,7 @@ class OC_Preferences{ } /** - * @brief Remove app of user from preferences + * Remove app of user from preferences * @param string $user user * @param string $app app * @return bool @@ -121,7 +121,7 @@ class OC_Preferences{ } /** - * @brief Remove user from preferences + * Remove user from preferences * @param string $user user * @return bool * @@ -133,7 +133,7 @@ class OC_Preferences{ } /** - * @brief Remove app from all users + * Remove app from all users * @param string $app app * @return bool * diff --git a/lib/private/log/errorhandler.php b/lib/private/log/errorhandler.php index 1dde6b507fc..4345b3f6b70 100644 --- a/lib/private/log/errorhandler.php +++ b/lib/private/log/errorhandler.php @@ -15,7 +15,7 @@ class ErrorHandler { private static $logger; /** - * @brief remove password in URLs + * remove password in URLs * @param string $msg * @return string */ diff --git a/lib/private/migrate.php b/lib/private/migrate.php index 98c825aafd8..8d88181ca19 100644 --- a/lib/private/migrate.php +++ b/lib/private/migrate.php @@ -53,7 +53,7 @@ class OC_Migrate{ } /** - * @brief finds and loads the providers + * finds and loads the providers */ static private function findProviders() { // Find the providers @@ -68,7 +68,7 @@ class OC_Migrate{ } /** - * @brief exports a user, or owncloud instance + * exports a user, or owncloud instance * @param string $uid user id of user to export if export type is user, defaults to current * @param string $type type of export, defualts to user * @param string $path path to zip output folder @@ -192,7 +192,7 @@ class OC_Migrate{ } /** - * @brief imports a user, or owncloud instance + * imports a user, or owncloud instance * @param string $path path to zip * @param string $type type of import (user or instance) * @param string|null|int $uid userid of new user @@ -307,7 +307,7 @@ class OC_Migrate{ } /** - * @brief recursively deletes a directory + * recursively deletes a directory * @param string $dir path of dir to delete * @param bool $deleteRootToo delete the root directory * @return bool @@ -332,7 +332,7 @@ class OC_Migrate{ } /** - * @brief tries to extract the import zip + * tries to extract the import zip * @param string $path path to the zip * @return string path to extract location (with a trailing slash) or false on failure */ @@ -356,7 +356,7 @@ class OC_Migrate{ } /** - * @brief creates a migration.db in the users data dir with their app data in + * creates a migration.db in the users data dir with their app data in * @return bool whether operation was successfull */ private static function exportAppData( ) { @@ -406,7 +406,7 @@ class OC_Migrate{ /** - * @brief generates json containing export info, and merges any data supplied + * generates json containing export info, and merges any data supplied * @param array $array of data to include in the returned json * @return string */ @@ -430,7 +430,7 @@ class OC_Migrate{ } /** - * @brief connects to migration.db, or creates if not found + * connects to migration.db, or creates if not found * @param string $path to migration.db, defaults to user data dir * @return bool whether the operation was successful */ @@ -460,7 +460,7 @@ class OC_Migrate{ } /** - * @brief creates the tables in migration.db from an apps database.xml + * creates the tables in migration.db from an apps database.xml * @param string $appid id of the app * @return bool whether the operation was successful */ @@ -498,7 +498,7 @@ class OC_Migrate{ } /** - * @brief tries to create the zip + * tries to create the zip * @return bool */ static private function createZip() { @@ -519,7 +519,7 @@ class OC_Migrate{ } /** - * @brief returns an array of apps that support migration + * returns an array of apps that support migration * @return array */ static public function getApps() { @@ -534,7 +534,7 @@ class OC_Migrate{ } /** - * @brief imports a new user + * imports a new user * @param string $db string path to migration.db * @param object $info object of migration info * @param string|null|int $uid uid to use diff --git a/lib/private/migration/content.php b/lib/private/migration/content.php index d3b2fe836a4..cb5d9ad1472 100644 --- a/lib/private/migration/content.php +++ b/lib/private/migration/content.php @@ -33,7 +33,7 @@ class OC_Migration_Content{ private $tmpfiles=array(); /** - * @brief sets up the + * sets up the * @param ZipArchive $zip ZipArchive object * @param object $db a database object (required for exporttype user) * @return bool|null @@ -46,7 +46,7 @@ class OC_Migration_Content{ } /** - * @brief prepares the db + * prepares the db * @param string $query the sql query to prepare */ public function prepare( $query ) { @@ -71,7 +71,7 @@ class OC_Migration_Content{ } /** - * @brief processes the db query + * processes the db query * @param string $query the query to process * @return string of processed query */ @@ -85,7 +85,7 @@ class OC_Migration_Content{ } /** - * @brief copys rows to migration.db from the main database + * copys rows to migration.db from the main database * @param array $options array of options. * @return bool */ @@ -127,7 +127,7 @@ class OC_Migration_Content{ } /** - * @brief saves a sql data set into migration.db + * saves a sql data set into migration.db * @param OC_DB_StatementWrapper $data a sql data set returned from self::prepare()->query() * @param array $options array of copyRows options * @return void @@ -166,7 +166,7 @@ class OC_Migration_Content{ } /** - * @brief adds a directory to the zip object + * adds a directory to the zip object * @param boolean|string $dir string path of the directory to add * @param bool $recursive * @param string $internaldir path of folder to add dir to in zip @@ -201,7 +201,7 @@ class OC_Migration_Content{ } /** - * @brief adds a file to the zip from a given string + * adds a file to the zip from a given string * @param string $data string of data to add * @param string $path the relative path inside of the zip to save the file to * @return bool @@ -220,7 +220,7 @@ class OC_Migration_Content{ } /** - * @brief closes the zip, removes temp files + * closes the zip, removes temp files * @return bool */ public function finish() { @@ -235,7 +235,7 @@ class OC_Migration_Content{ } /** - * @brief cleans up after the zip + * cleans up after the zip */ private function cleanup() { // Delete tmp files diff --git a/lib/private/migration/provider.php b/lib/private/migration/provider.php index 2829a97a776..a7c611dcdd4 100644 --- a/lib/private/migration/provider.php +++ b/lib/private/migration/provider.php @@ -17,19 +17,19 @@ abstract class OC_Migration_Provider{ } /** - * @brief exports data for apps + * exports data for apps * @return array appdata to be exported */ abstract function export( ); /** - * @brief imports data for the app + * imports data for the app * @return void */ abstract function import( ); /** - * @brief sets the OC_Migration_Content object to $this->content + * sets the OC_Migration_Content object to $this->content * @param OC_Migration_Content $content a OC_Migration_Content object */ public function setData( $uid, $content, $info=null ) { @@ -43,7 +43,7 @@ abstract class OC_Migration_Provider{ } /** - * @brief returns the appid of the provider + * returns the appid of the provider * @return string */ public function getID() { diff --git a/lib/private/navigationmanager.php b/lib/private/navigationmanager.php index d7111af03cf..8ad2f4c8f63 100644 --- a/lib/private/navigationmanager.php +++ b/lib/private/navigationmanager.php @@ -29,7 +29,7 @@ class NavigationManager implements \OCP\INavigationManager { } /** - * @brief returns all the added Menu entries + * returns all the added Menu entries * @return array an array of the added entries */ public function getAll() { @@ -37,7 +37,7 @@ class NavigationManager implements \OCP\INavigationManager { } /** - * @brief removes all the entries + * removes all the entries */ public function clear() { $this->entries = array(); @@ -52,7 +52,7 @@ class NavigationManager implements \OCP\INavigationManager { } /** - * @brief gets the active Menu entry + * gets the active Menu entry * @return string id or empty string * * This function returns the id of the active navigation entry (set by diff --git a/lib/private/ocsclient.php b/lib/private/ocsclient.php index fb8282747eb..39d7e9ccccd 100644 --- a/lib/private/ocsclient.php +++ b/lib/private/ocsclient.php @@ -29,7 +29,7 @@ class OC_OCSClient{ /** - * @brief Get the url of the OCS AppStore server. + * Get the url of the OCS AppStore server. * @return string of the AppStore server * * This function returns the url of the OCS AppStore server. It´s possible @@ -47,7 +47,7 @@ class OC_OCSClient{ /** - * @brief Get the content of an OCS url call. + * Get the content of an OCS url call. * @return string of the response * This function calls an OCS server and returns the response. It also sets a sane timeout * @param string $url @@ -58,7 +58,7 @@ class OC_OCSClient{ } /** - * @brief Get all the categories from the OCS server + * Get all the categories from the OCS server * @return array an array of category ids * @note returns NULL if config value appstoreenabled is set to false * This function returns a list of all the application categories on the OCS server @@ -91,7 +91,7 @@ class OC_OCSClient{ } /** - * @brief Get all the applications from the OCS server + * Get all the applications from the OCS server * @return array an array of application data * * This function returns a list of all the applications on the OCS server @@ -148,7 +148,7 @@ class OC_OCSClient{ /** - * @brief Get an the applications from the OCS server + * Get an the applications from the OCS server * @param string $id * @return array an array of application data * @@ -191,7 +191,7 @@ class OC_OCSClient{ } /** - * @brief Get the download url for an application from the OCS server + * Get the download url for an application from the OCS server * @return array an array of application data * * This function returns an download url for an applications from the OCS server diff --git a/lib/private/preferences.php b/lib/private/preferences.php index 3cadb6a2e97..e6d9f28b1d6 100644 --- a/lib/private/preferences.php +++ b/lib/private/preferences.php @@ -68,7 +68,7 @@ class Preferences { } /** - * @brief Get all users using the preferences + * Get all users using the preferences * @return array an array of user ids * * This function returns a list of all users that have at least one entry @@ -109,7 +109,7 @@ class Preferences { } /** - * @brief Get all apps of an user + * Get all apps of an user * @param string $user user * @return integer[] with app ids * @@ -122,7 +122,7 @@ class Preferences { } /** - * @brief Get the available keys for an app + * Get the available keys for an app * @param string $user user * @param string $app the app we are looking for * @return array an array of key names @@ -140,7 +140,7 @@ class Preferences { } /** - * @brief Gets the preference + * Gets the preference * @param string $user user * @param string $app app * @param string $key key @@ -160,7 +160,7 @@ class Preferences { } /** - * @brief sets a value in the preferences + * sets a value in the preferences * @param string $user user * @param string $app app * @param string $key key @@ -206,7 +206,7 @@ class Preferences { } /** - * @brief Deletes a key + * Deletes a key * @param string $user user * @param string $app app * @param string $key key @@ -227,7 +227,7 @@ class Preferences { } /** - * @brief Remove app of user from preferences + * Remove app of user from preferences * @param string $user user * @param string $app app * @@ -246,7 +246,7 @@ class Preferences { } /** - * @brief Remove user from preferences + * Remove user from preferences * @param string $user user * * Removes all keys in preferences belonging to the user. @@ -261,7 +261,7 @@ class Preferences { } /** - * @brief Remove app from all users + * Remove app from all users * @param string $app app * * Removes all keys in preferences belonging to the app. diff --git a/lib/private/preview.php b/lib/private/preview.php index eb932470a47..8089379bde5 100755 --- a/lib/private/preview.php +++ b/lib/private/preview.php @@ -66,7 +66,7 @@ class Preview { protected $info; /** - * @brief check if thumbnail or bigger version of thumbnail of file is cached + * check if thumbnail or bigger version of thumbnail of file is cached * @param string $user userid - if no user is given, OC_User::getUser will be used * @param string $root path of root * @param string $file The path to the file where you want a thumbnail from @@ -111,7 +111,7 @@ class Preview { } /** - * @brief returns the path of the file you want a thumbnail from + * returns the path of the file you want a thumbnail from * @return string */ public function getFile() { @@ -119,7 +119,7 @@ class Preview { } /** - * @brief returns the max width of the preview + * returns the max width of the preview * @return integer */ public function getMaxX() { @@ -127,7 +127,7 @@ class Preview { } /** - * @brief returns the max height of the preview + * returns the max height of the preview * @return integer */ public function getMaxY() { @@ -135,7 +135,7 @@ class Preview { } /** - * @brief returns whether or not scalingup is enabled + * returns whether or not scalingup is enabled * @return bool */ public function getScalingUp() { @@ -143,7 +143,7 @@ class Preview { } /** - * @brief returns the name of the thumbnailfolder + * returns the name of the thumbnailfolder * @return string */ public function getThumbnailsFolder() { @@ -151,7 +151,7 @@ class Preview { } /** - * @brief returns the max scale factor + * returns the max scale factor * @return string */ public function getMaxScaleFactor() { @@ -159,7 +159,7 @@ class Preview { } /** - * @brief returns the max width set in ownCloud's config + * returns the max width set in ownCloud's config * @return string */ public function getConfigMaxX() { @@ -167,7 +167,7 @@ class Preview { } /** - * @brief returns the max height set in ownCloud's config + * returns the max height set in ownCloud's config * @return string */ public function getConfigMaxY() { @@ -189,7 +189,7 @@ class Preview { } /** - * @brief set the path of the file you want a thumbnail from + * set the path of the file you want a thumbnail from * @param string $file * @return \OC\Preview $this */ @@ -206,7 +206,7 @@ class Preview { } /** - * @brief set mime type explicitly + * set mime type explicitly * @param string $mimeType */ public function setMimetype($mimeType) { @@ -214,7 +214,7 @@ class Preview { } /** - * @brief set the the max width of the preview + * set the the max width of the preview * @param int $maxX * @throws \Exception * @return \OC\Preview $this @@ -235,7 +235,7 @@ class Preview { } /** - * @brief set the the max height of the preview + * set the the max height of the preview * @param int $maxY * @throws \Exception * @return \OC\Preview $this @@ -256,7 +256,7 @@ class Preview { } /** - * @brief set whether or not scalingup is enabled + * set whether or not scalingup is enabled * @param bool $scalingUp * @return \OC\Preview $this */ @@ -274,7 +274,7 @@ class Preview { } /** - * @brief check if all parameters are valid + * check if all parameters are valid * @return bool */ public function isFileValid() { @@ -293,7 +293,7 @@ class Preview { } /** - * @brief deletes previews of a file with specific x and y + * deletes previews of a file with specific x and y * @return bool */ public function deletePreview() { @@ -310,7 +310,7 @@ class Preview { } /** - * @brief deletes all previews of a file + * deletes all previews of a file * @return bool */ public function deleteAllPreviews() { @@ -328,7 +328,7 @@ class Preview { } /** - * @brief check if thumbnail or bigger version of thumbnail of file is cached + * check if thumbnail or bigger version of thumbnail of file is cached * @param int $fileId fileId of the original image * @return string|false path to thumbnail if it exists or false */ @@ -348,7 +348,7 @@ class Preview { } /** - * @brief check if a bigger version of thumbnail of file is cached + * check if a bigger version of thumbnail of file is cached * @param int $fileId fileId of the original image * @return string|false path to bigger thumbnail if it exists or false */ @@ -380,7 +380,7 @@ class Preview { } /** - * @brief get possible bigger thumbnails of the given image + * get possible bigger thumbnails of the given image * @param int $fileId fileId of the original image * @return array an array of paths to bigger thumbnails */ @@ -433,12 +433,12 @@ class Preview { * @return bool */ private function unscalable($x, $y) { - + $maxX = $this->getMaxX(); $maxY = $this->getMaxY(); $scalingUp = $this->getScalingUp(); $maxScaleFactor = $this->getMaxScaleFactor(); - + if ($x < $maxX || $y < $maxY) { if ($scalingUp) { $scalefactor = $maxX / $x; @@ -453,7 +453,7 @@ class Preview { } /** - * @brief return a preview of a file + * return a preview of a file * @return \OC_Image */ public function getPreview() { @@ -529,7 +529,7 @@ class Preview { } /** - * @brief show preview + * show preview * @return void */ public function showPreview($mimeType = null) { @@ -541,7 +541,7 @@ class Preview { } /** - * @brief resize, crop and fix orientation + * resize, crop and fix orientation * @return void */ private function resizeAndCrop() { @@ -652,7 +652,7 @@ class Preview { } /** - * @brief register a new preview provider to be used + * register a new preview provider to be used * @param array $options * @return void */ @@ -661,7 +661,7 @@ class Preview { } /** - * @brief create instances of all the registered preview providers + * create instances of all the registered preview providers * @return void */ private static function initProviders() { diff --git a/lib/private/previewmanager.php b/lib/private/previewmanager.php index ac9a866a75b..23dbee13c7d 100755 --- a/lib/private/previewmanager.php +++ b/lib/private/previewmanager.php @@ -13,7 +13,7 @@ use OCP\IPreview; class PreviewManager implements IPreview { /** - * @brief return a preview of a file + * return a preview of a file * @param string $file The path to the file where you want a thumbnail from * @param int $maxX The maximum X size of the thumbnail. It can be smaller depending on the shape of the image * @param int $maxY The maximum Y size of the thumbnail. It can be smaller depending on the shape of the image @@ -27,7 +27,7 @@ class PreviewManager implements IPreview { } /** - * @brief returns true if the passed mime type is supported + * returns true if the passed mime type is supported * @param string $mimeType * @return boolean */ diff --git a/lib/private/request.php b/lib/private/request.php index cf9a316b851..09928021a7f 100755 --- a/lib/private/request.php +++ b/lib/private/request.php @@ -16,7 +16,7 @@ class OC_Request { const REGEX_LOCALHOST = '/^(127\.0\.0\.1|localhost)(:[0-9]+|)$/'; /** - * @brief Check overwrite condition + * Check overwrite condition * @param string $type * @return bool */ @@ -27,7 +27,7 @@ class OC_Request { } /** - * @brief Checks whether a domain is considered as trusted from the list + * Checks whether a domain is considered as trusted from the list * of trusted domains. If no trusted domains have been configured, returns * true. * This is used to prevent Host Header Poisoning. @@ -47,7 +47,7 @@ class OC_Request { } /** - * @brief Returns the unverified server host from the headers without checking + * Returns the unverified server host from the headers without checking * whether it is a trusted domain * @return string the server host * @@ -87,7 +87,7 @@ class OC_Request { } /** - * @brief Returns the server host from the headers, or the first configured + * Returns the server host from the headers, or the first configured * trusted domain if the host isn't in the trusted list * @return string the server host * @@ -120,7 +120,7 @@ class OC_Request { } /** - * @brief Returns the server protocol + * Returns the server protocol * @return string the server protocol * * Returns the server protocol. It respects reverse proxy servers and load balancers @@ -142,7 +142,7 @@ class OC_Request { } /** - * @brief Returns the request uri + * Returns the request uri * @return string the request uri * * Returns the request uri, even if the website uses one or more @@ -158,7 +158,7 @@ class OC_Request { } /** - * @brief Returns the script name + * Returns the script name * @return string the script name * * Returns the script name, even if the website uses one or more @@ -176,7 +176,7 @@ class OC_Request { } /** - * @brief get Path info from request + * get Path info from request * @return string Path info or false when not found */ public static function getPathInfo() { @@ -200,7 +200,7 @@ class OC_Request { } /** - * @brief get Path info from request, not urldecoded + * get Path info from request, not urldecoded * @throws Exception * @return string Path info or false when not found */ @@ -242,7 +242,7 @@ class OC_Request { } /** - * @brief Check if the requester sent along an mtime + * Check if the requester sent along an mtime * @return false or an mtime */ static public function hasModificationTime () { diff --git a/lib/private/response.php b/lib/private/response.php index f976925fb2e..e8064c8588f 100644 --- a/lib/private/response.php +++ b/lib/private/response.php @@ -15,7 +15,7 @@ class OC_Response { const STATUS_SERVICE_UNAVAILABLE = 503; /** - * @brief Enable response caching by sending correct HTTP headers + * Enable response caching by sending correct HTTP headers * @param integer $cache_time time to cache the response * >0 cache time in seconds * 0 and <0 enable default browser caching @@ -41,7 +41,7 @@ class OC_Response { } /** - * @brief disable browser caching + * disable browser caching * @see enableCaching with cache_time = 0 */ static public function disableCaching() { @@ -49,7 +49,7 @@ class OC_Response { } /** - * @brief Set response status + * Set response status * @param int $status a HTTP status code, see also the STATUS constants */ static public function setStatus($status) { @@ -83,7 +83,7 @@ class OC_Response { } /** - * @brief Send redirect response + * Send redirect response * @param string $location to redirect to */ static public function redirect($location) { @@ -92,7 +92,7 @@ class OC_Response { } /** - * @brief Set reponse expire time + * Set reponse expire time * @param string|DateTime $expires date-time when the response expires * string for DateInterval from now * DateTime object when to expire response @@ -170,7 +170,7 @@ class OC_Response { } /** - * @brief Send file as response, checking and setting caching headers + * Send file as response, checking and setting caching headers * @param string $filepath of file to send */ static public function sendFile($filepath) { diff --git a/lib/private/setup.php b/lib/private/setup.php index 4889f603332..7a08816c4b1 100644 --- a/lib/private/setup.php +++ b/lib/private/setup.php @@ -152,7 +152,7 @@ class OC_Setup { } /** - * @brief Post installation checks + * Post installation checks */ public static function postSetupCheck($params) { // setup was successful -> webdav testing now diff --git a/lib/private/share/helper.php b/lib/private/share/helper.php index e04180e00e4..ab9e0ca4926 100644 --- a/lib/private/share/helper.php +++ b/lib/private/share/helper.php @@ -202,7 +202,7 @@ class Helper extends \OC\Share\Constants { } /** - * @brief get default expire settings defined by the admin + * get default expire settings defined by the admin * @return array contains 'defaultExpireDateSet', 'enforceExpireDate', 'expireAfterDays' */ public static function getDefaultExpireSetting() { @@ -222,7 +222,7 @@ class Helper extends \OC\Share\Constants { } /** - * @brief calculate expire date + * calculate expire date * @param array $defaultExpireSettings contains 'defaultExpireDateSet', 'enforceExpireDate', 'expireAfterDays' * @param int $creationTime timestamp when the share was created * @param int $userExpireDate expire timestamp set by the user diff --git a/lib/private/share/mailnotifications.php b/lib/private/share/mailnotifications.php index ca0dff6562d..cb74dcf8b90 100644 --- a/lib/private/share/mailnotifications.php +++ b/lib/private/share/mailnotifications.php @@ -66,7 +66,7 @@ class MailNotifications { } /** - * @brief inform users if a file was shared with them + * inform users if a file was shared with them * * @param array $recipientList list of recipients * @param string $itemSource shared item source @@ -125,7 +125,7 @@ class MailNotifications { } /** - * @brief inform recipient about public link share + * inform recipient about public link share * * @param string $recipient recipient email address * @param string $filename the shared file @@ -150,7 +150,7 @@ class MailNotifications { } /** - * @brief create mail body for plain text and html mail + * create mail body for plain text and html mail * * @param string $filename the shared file * @param string $link link to the shared file diff --git a/lib/private/share/share.php b/lib/private/share/share.php index 2846631a693..16bc492d383 100644 --- a/lib/private/share/share.php +++ b/lib/private/share/share.php @@ -1718,7 +1718,7 @@ class Share extends \OC\Share\Constants { } /** - * @brief construct select statement + * construct select statement * @param int $format * @param boolean $fileDependent ist it a file/folder share or a generla share * @param string $uidOwner @@ -1762,7 +1762,7 @@ class Share extends \OC\Share\Constants { /** - * @brief transform db results + * transform db results * @param array $row result */ private static function transformDBResults(&$row) { @@ -1793,7 +1793,7 @@ class Share extends \OC\Share\Constants { } /** - * @brief format result + * format result * @param array $items result * @param string $column is it a file share or a general share ('file_target' or 'item_target') * @param \OCP\Share_Backend $backend sharing backend diff --git a/lib/private/subadmin.php b/lib/private/subadmin.php index 3e8b73d55b0..f5ef00ce4fe 100644 --- a/lib/private/subadmin.php +++ b/lib/private/subadmin.php @@ -31,7 +31,7 @@ OC_Hook::connect('OC_User', 'post_deleteGroup', 'OC_SubAdmin', 'post_deleteGroup class OC_SubAdmin{ /** - * @brief add a SubAdmin + * add a SubAdmin * @param string $uid uid of the SubAdmin * @param string $gid gid of the group * @return boolean @@ -44,7 +44,7 @@ class OC_SubAdmin{ } /** - * @brief delete a SubAdmin + * delete a SubAdmin * @param string $uid uid of the SubAdmin * @param string $gid gid of the group * @return boolean @@ -57,7 +57,7 @@ class OC_SubAdmin{ } /** - * @brief get groups of a SubAdmin + * get groups of a SubAdmin * @param string $uid uid of the SubAdmin * @return array */ @@ -72,7 +72,7 @@ class OC_SubAdmin{ } /** - * @brief get SubAdmins of a group + * get SubAdmins of a group * @param string $gid gid of the group * @return array */ @@ -87,7 +87,7 @@ class OC_SubAdmin{ } /** - * @brief get all SubAdmins + * get all SubAdmins * @return array */ public static function getAllSubAdmins() { @@ -101,7 +101,7 @@ class OC_SubAdmin{ } /** - * @brief checks if a user is a SubAdmin of a group + * checks if a user is a SubAdmin of a group * @param string $uid uid of the subadmin * @param string $gid gid of the group * @return bool @@ -117,7 +117,7 @@ class OC_SubAdmin{ } /** - * @brief checks if a user is a SubAdmin + * checks if a user is a SubAdmin * @param string $uid uid of the subadmin * @return bool */ @@ -137,7 +137,7 @@ class OC_SubAdmin{ } /** - * @brief checks if a user is a accessible by a subadmin + * checks if a user is a accessible by a subadmin * @param string $subadmin uid of the subadmin * @param string $user uid of the user * @return bool @@ -159,14 +159,14 @@ class OC_SubAdmin{ } /* - * @brief alias for self::isSubAdminofGroup() + * alias for self::isSubAdminofGroup() */ public static function isGroupAccessible($subadmin, $group) { return self::isSubAdminofGroup($subadmin, $group); } /** - * @brief delete all SubAdmins by uid + * delete all SubAdmins by uid * @param array $parameters * @return boolean */ @@ -177,7 +177,7 @@ class OC_SubAdmin{ } /** - * @brief delete all SubAdmins by gid + * delete all SubAdmins by gid * @param array $parameters * @return boolean */ diff --git a/lib/private/template.php b/lib/private/template.php index dfeb5d14b08..eaa58b769d7 100644 --- a/lib/private/template.php +++ b/lib/private/template.php @@ -33,7 +33,7 @@ class OC_Template extends \OC\Template\Base { protected $app; // app id /** - * @brief Constructor + * Constructor * @param string $app app providing the template * @param string $name of the template file (without suffix) * @param string $renderas = ""; produce a full page @@ -97,7 +97,7 @@ class OC_Template extends \OC\Template\Base { } /** - * @brief Returns the formfactor extension for current formfactor + * Returns the formfactor extension for current formfactor */ static public function getFormFactorExtension() { @@ -130,7 +130,7 @@ class OC_Template extends \OC\Template\Base { } /** - * @brief find the template with the given name + * find the template with the given name * @param string $name of the template file (without suffix) * * Will select the template file for the selected theme and formfactor. @@ -154,7 +154,7 @@ class OC_Template extends \OC\Template\Base { } /** - * @brief Add a custom element to the header + * Add a custom element to the header * @param string $tag tag name of the element * @param array $attributes array of attributes for the element * @param string $text the text content for the element @@ -164,7 +164,7 @@ class OC_Template extends \OC\Template\Base { } /** - * @brief Process the template + * Process the template * @return boolean|string * * This function process the template. If $this->renderas is set, it @@ -191,7 +191,7 @@ class OC_Template extends \OC\Template\Base { } /** - * @brief Include template + * Include template * @return string returns content of included template * * Includes another template. use <?php echo $this->inc('template'); ?> to @@ -202,7 +202,7 @@ class OC_Template extends \OC\Template\Base { } /** - * @brief Shortcut to print a simple page for users + * Shortcut to print a simple page for users * @param string $application The application we render the template for * @param string $name Name of the template * @param array $parameters Parameters for the template @@ -217,7 +217,7 @@ class OC_Template extends \OC\Template\Base { } /** - * @brief Shortcut to print a simple page for admins + * Shortcut to print a simple page for admins * @param string $application The application we render the template for * @param string $name Name of the template * @param array $parameters Parameters for the template @@ -232,7 +232,7 @@ class OC_Template extends \OC\Template\Base { } /** - * @brief Shortcut to print a simple page for guests + * Shortcut to print a simple page for guests * @param string $application The application we render the template for * @param string $name Name of the template * @param array|string $parameters Parameters for the template @@ -247,7 +247,7 @@ class OC_Template extends \OC\Template\Base { } /** - * @brief Print a fatal error page and terminates the script + * Print a fatal error page and terminates the script * @param string $error_msg The error message to show * @param string $hint An optional hint message * Warning: All data passed to $hint needs to get sanitized using OC_Util::sanitizeHTML @@ -259,7 +259,7 @@ class OC_Template extends \OC\Template\Base { $content->printPage(); die(); } - + /** * print error page using Exception details * @param Exception $exception diff --git a/lib/private/template/base.php b/lib/private/template/base.php index 3d7c685c1cf..dbdfce24324 100644 --- a/lib/private/template/base.php +++ b/lib/private/template/base.php @@ -59,7 +59,7 @@ class Base { } /** - * @brief Assign variables + * Assign variables * @param string $key key * @param array|bool|integer|string $value value * @return bool @@ -75,7 +75,7 @@ class Base { } /** - * @brief Appends a variable + * Appends a variable * @param string $key key * @param mixed $value value * @return boolean|null @@ -94,7 +94,7 @@ class Base { } /** - * @brief Prints the proceeded template + * Prints the proceeded template * @return bool * * This function proceeds the template and prints its output. @@ -111,7 +111,7 @@ class Base { } /** - * @brief Process the template + * Process the template * @return string * * This function processes the template. @@ -121,7 +121,7 @@ class Base { } /** - * @brief doing the actual work + * doing the actual work * @param string $file * @return string content * diff --git a/lib/private/template/functions.php b/lib/private/template/functions.php index 3f5312c0a7b..46e48274001 100644 --- a/lib/private/template/functions.php +++ b/lib/private/template/functions.php @@ -24,7 +24,7 @@ function print_unescaped($string) { } /** - * @brief make OC_Helper::linkTo available as a simple function + * make OC_Helper::linkTo available as a simple function * @param string $app app * @param string $file file * @param array $args array with param=>value, will be appended to the returned url @@ -45,7 +45,7 @@ function link_to_docs($key) { } /** - * @brief make OC_Helper::imagePath available as a simple function + * make OC_Helper::imagePath available as a simple function * @param string $app app * @param string $image image * @return string link to the image @@ -57,7 +57,7 @@ function image_path( $app, $image ) { } /** - * @brief make OC_Helper::mimetypeIcon available as a simple function + * make OC_Helper::mimetypeIcon available as a simple function * @param string $mimetype mimetype * @return string link to the image * @@ -68,7 +68,7 @@ function mimetype_icon( $mimetype ) { } /** - * @brief make preview_icon available as a simple function + * make preview_icon available as a simple function * Returns the path to the preview of the image. * @param string $path path of file * @return link to the preview @@ -87,7 +87,7 @@ function publicPreview_icon ( $path, $token ) { } /** - * @brief make OC_Helper::humanFileSize available as a simple function + * make OC_Helper::humanFileSize available as a simple function * @param int $bytes size in bytes * @return string size as string * @@ -98,7 +98,7 @@ function human_file_size( $bytes ) { } /** - * @brief Strips the timestamp of its time value + * Strips the timestamp of its time value * @param int $timestamp UNIX timestamp to strip * @return $timestamp without time value */ @@ -109,7 +109,7 @@ function strip_time($timestamp){ } /** - * @brief Formats timestamp relatively to the current time using + * Formats timestamp relatively to the current time using * a human-friendly format like "x minutes ago" or "yesterday" * @param int $timestamp timestamp to format * @param int $fromTime timestamp to compare from, defaults to current time diff --git a/lib/private/template/resourcelocator.php b/lib/private/template/resourcelocator.php index 900aa6a8f08..7976c415922 100644 --- a/lib/private/template/resourcelocator.php +++ b/lib/private/template/resourcelocator.php @@ -52,7 +52,7 @@ abstract class ResourceLocator { } /* - * @brief append the $file resource if exist at $root + * append the $file resource if exist at $root * @param string $root path to check * @param string $file the filename * @param string|null $webroot base for path, default map $root to $webroot diff --git a/lib/private/urlgenerator.php b/lib/private/urlgenerator.php index b37ef89d40d..af5d977eeab 100644 --- a/lib/private/urlgenerator.php +++ b/lib/private/urlgenerator.php @@ -29,7 +29,7 @@ class URLGenerator implements IURLGenerator { } /** - * @brief Creates an url using a defined route + * Creates an url using a defined route * @param string $route * @param array $parameters * @internal param array $args with param=>value, will be appended to the returned url @@ -43,7 +43,7 @@ class URLGenerator implements IURLGenerator { } /** - * @brief Creates an url + * Creates an url * @param string $app app * @param string $file file * @param array $args array with param=>value, will be appended to the returned url @@ -92,7 +92,7 @@ class URLGenerator implements IURLGenerator { } /** - * @brief Creates path to an image + * Creates path to an image * @param string $app app * @param string $image image name * @throws \RuntimeException If the image does not exist diff --git a/lib/private/user.php b/lib/private/user.php index 90aac88cdc8..9276d7923c9 100644 --- a/lib/private/user.php +++ b/lib/private/user.php @@ -62,7 +62,7 @@ class OC_User { private static $incognitoMode = false; /** - * @brief registers backend + * registers backend * @param string $backend name of the backend * @deprecated Add classes by calling useBackend with a class instance instead * @return bool @@ -75,7 +75,7 @@ class OC_User { } /** - * @brief gets available backends + * gets available backends * @deprecated * @return array an array of backends * @@ -86,7 +86,7 @@ class OC_User { } /** - * @brief gets used backends + * gets used backends * @deprecated * @return array an array of backends * @@ -97,7 +97,7 @@ class OC_User { } /** - * @brief Adds the backend to the list of used backends + * Adds the backend to the list of used backends * @param string|OC_User_Interface $backend default: database The backend to use for user management * @return bool * @@ -169,7 +169,7 @@ class OC_User { } /** - * @brief Create a new user + * Create a new user * @param string $uid The username of the user to create * @param string $password The password of the new user * @throws Exception @@ -185,7 +185,7 @@ class OC_User { } /** - * @brief delete a user + * delete a user * @param string $uid The username of the user to delete * @return bool * @@ -223,7 +223,7 @@ class OC_User { } /** - * @brief Try to login a user + * Try to login a user * @param string $uid The username of the user to log in * @param string $password The password of the user * @return boolean|null @@ -236,7 +236,7 @@ class OC_User { } /** - * @brief Try to login a user, assuming authentication + * Try to login a user, assuming authentication * has already happened (e.g. via Single Sign On). * * Log in a user and regenerate a new session. @@ -262,7 +262,7 @@ class OC_User { } /** - * @brief Verify with Apache whether user is authenticated. + * Verify with Apache whether user is authenticated. * * @return boolean|null * true: authenticated @@ -286,14 +286,14 @@ class OC_User { /** - * @brief Sets user id for session and triggers emit + * Sets user id for session and triggers emit */ public static function setUserId($uid) { OC::$session->set('user_id', $uid); } /** - * @brief Sets user display name for session + * Sets user display name for session * @param string $uid * @param null $displayName * @return bool Whether the display name could get set @@ -311,7 +311,7 @@ class OC_User { } /** - * @brief Logs the current user out and kills all the session data + * Logs the current user out and kills all the session data * * Logout, destroys session */ @@ -320,7 +320,7 @@ class OC_User { } /** - * @brief Check if the user is logged in + * Check if the user is logged in * @return bool * * Checks if the user is logged in @@ -333,7 +333,7 @@ class OC_User { } /** - * @brief set incognito mode, e.g. if a user wants to open a public link + * set incognito mode, e.g. if a user wants to open a public link * @param bool $status */ public static function setIncognitoMode($status) { @@ -358,7 +358,7 @@ class OC_User { } /** - * @brief Check if the user is an admin user + * Check if the user is an admin user * @param string $uid uid of the admin * @return bool */ @@ -371,7 +371,7 @@ class OC_User { /** - * @brief get the user id of the user currently logged in. + * get the user id of the user currently logged in. * @return string uid or false */ public static function getUser() { @@ -384,7 +384,7 @@ class OC_User { } /** - * @brief get the display name of the user currently logged in. + * get the display name of the user currently logged in. * @param string $uid * @return string uid or false */ @@ -407,7 +407,7 @@ class OC_User { } /** - * @brief Autogenerate a password + * Autogenerate a password * @return string * * generates a password @@ -417,7 +417,7 @@ class OC_User { } /** - * @brief Set password + * Set password * @param string $uid The username * @param string $password The new password * @param string $recoveryPassword for the encryption app to reset encryption keys @@ -435,7 +435,7 @@ class OC_User { } /** - * @brief Check whether user can change his avatar + * Check whether user can change his avatar * @param string $uid The username * @return bool * @@ -451,7 +451,7 @@ class OC_User { } /** - * @brief Check whether user can change his password + * Check whether user can change his password * @param string $uid The username * @return bool * @@ -467,7 +467,7 @@ class OC_User { } /** - * @brief Check whether user can change his display name + * Check whether user can change his display name * @param string $uid The username * @return bool * @@ -483,7 +483,7 @@ class OC_User { } /** - * @brief Check if the password is correct + * Check if the password is correct * @param string $uid The username * @param string $password The password * @return string|false user id a string on success, false otherwise @@ -516,7 +516,7 @@ class OC_User { } /** - * @brief Get a list of all users + * Get a list of all users * @return array an array of all uids * * Get a list of all users. @@ -534,7 +534,7 @@ class OC_User { } /** - * @brief Get a list of all users display name + * Get a list of all users display name * @param string $search * @param int $limit * @param int $offset @@ -552,7 +552,7 @@ class OC_User { } /** - * @brief check if a user exists + * check if a user exists * @param string $uid the username * @return boolean */ @@ -600,7 +600,7 @@ class OC_User { } /** - * @brief Set cookie value to use in next page load + * Set cookie value to use in next page load * @param string $username username to be set * @param string $token */ @@ -609,14 +609,14 @@ class OC_User { } /** - * @brief Remove cookie for "remember username" + * Remove cookie for "remember username" */ public static function unsetMagicInCookie() { self::getUserSession()->unsetMagicInCookie(); } /** - * @brief Returns the first active backend from self::$_usedBackends. + * Returns the first active backend from self::$_usedBackends. * @return OCP\Authentication\IApacheBackend|null if no backend active, otherwise OCP\Authentication\IApacheBackend */ private static function findFirstActiveUsedBackend() { diff --git a/lib/private/user/backend.php b/lib/private/user/backend.php index 8d2f0e935de..56c63085f18 100644 --- a/lib/private/user/backend.php +++ b/lib/private/user/backend.php @@ -61,7 +61,7 @@ abstract class OC_User_Backend implements OC_User_Interface { ); /** - * @brief Get all supported actions + * Get all supported actions * @return int bitwise-or'ed actions * * Returns the supported actions as int to be @@ -79,7 +79,7 @@ abstract class OC_User_Backend implements OC_User_Interface { } /** - * @brief Check if backend implements actions + * Check if backend implements actions * @param int $actions bitwise-or'ed actions * @return boolean * @@ -91,7 +91,7 @@ abstract class OC_User_Backend implements OC_User_Interface { } /** - * @brief delete a user + * delete a user * @param string $uid The username of the user to delete * @return bool * @@ -102,7 +102,7 @@ abstract class OC_User_Backend implements OC_User_Interface { } /** - * @brief Get a list of all users + * Get a list of all users * @return array an array of all uids * * Get a list of all users. @@ -112,7 +112,7 @@ abstract class OC_User_Backend implements OC_User_Interface { } /** - * @brief check if a user exists + * check if a user exists * @param string $uid the username * @return boolean */ @@ -121,7 +121,7 @@ abstract class OC_User_Backend implements OC_User_Interface { } /** - * @brief get the user's home directory + * get the user's home directory * @param string $uid the username * @return boolean */ @@ -130,7 +130,7 @@ abstract class OC_User_Backend implements OC_User_Interface { } /** - * @brief get display name of the user + * get display name of the user * @param string $uid user ID of the user * @return string display name */ @@ -139,7 +139,7 @@ abstract class OC_User_Backend implements OC_User_Interface { } /** - * @brief Get a list of all display names + * Get a list of all display names * @return array an array of all displayNames (value) and the corresponding uids (key) * * Get a list of all display names and user ids. @@ -154,7 +154,7 @@ abstract class OC_User_Backend implements OC_User_Interface { } /** - * @brief Check if a user list is available or not + * Check if a user list is available or not * @return boolean if users can be listed or not */ public function hasUserListings() { diff --git a/lib/private/user/database.php b/lib/private/user/database.php index 747895a8a95..d9263f6b5de 100644 --- a/lib/private/user/database.php +++ b/lib/private/user/database.php @@ -56,7 +56,7 @@ class OC_User_Database extends OC_User_Backend { } /** - * @brief Create a new user + * Create a new user * @param string $uid The username of the user to create * @param string $password The password of the new user * @return bool @@ -78,7 +78,7 @@ class OC_User_Database extends OC_User_Backend { } /** - * @brief delete a user + * delete a user * @param string $uid The username of the user to delete * @return bool * @@ -97,7 +97,7 @@ class OC_User_Database extends OC_User_Backend { } /** - * @brief Set password + * Set password * @param string $uid The username * @param string $password The new password * @return bool @@ -118,7 +118,7 @@ class OC_User_Database extends OC_User_Backend { } /** - * @brief Set display name + * Set display name * @param string $uid The username * @param string $displayName The new display name * @return bool @@ -138,7 +138,7 @@ class OC_User_Database extends OC_User_Backend { } /** - * @brief get display name of the user + * get display name of the user * @param string $uid user ID of the user * @return string display name */ @@ -148,7 +148,7 @@ class OC_User_Database extends OC_User_Backend { } /** - * @brief Get a list of all display names + * Get a list of all display names * @return array an array of all displayNames (value) and the correspondig uids (key) * * Get a list of all display names and user ids. @@ -168,7 +168,7 @@ class OC_User_Database extends OC_User_Backend { } /** - * @brief Check if the password is correct + * Check if the password is correct * @param string $uid The username * @param string $password The password * @return string @@ -201,7 +201,7 @@ class OC_User_Database extends OC_User_Backend { } /** - * @brief Load an user in the cache + * Load an user in the cache * @param string $uid the username * @return boolean */ @@ -225,7 +225,7 @@ class OC_User_Database extends OC_User_Backend { } /** - * @brief Get a list of all users + * Get a list of all users * @return array an array of all uids * * Get a list of all users. @@ -241,7 +241,7 @@ class OC_User_Database extends OC_User_Backend { } /** - * @brief check if a user exists + * check if a user exists * @param string $uid the username * @return boolean */ @@ -251,7 +251,7 @@ class OC_User_Database extends OC_User_Backend { } /** - * @brief get the user's home directory + * get the user's home directory * @param string $uid the username * @return string|false */ diff --git a/lib/private/user/dummy.php b/lib/private/user/dummy.php index d2ada37c80f..776168048f6 100644 --- a/lib/private/user/dummy.php +++ b/lib/private/user/dummy.php @@ -28,7 +28,7 @@ class OC_User_Dummy extends OC_User_Backend { private $users = array(); /** - * @brief Create a new user + * Create a new user * @param string $uid The username of the user to create * @param string $password The password of the new user * @return bool @@ -46,7 +46,7 @@ class OC_User_Dummy extends OC_User_Backend { } /** - * @brief delete a user + * delete a user * @param string $uid The username of the user to delete * @return bool * @@ -62,7 +62,7 @@ class OC_User_Dummy extends OC_User_Backend { } /** - * @brief Set password + * Set password * @param string $uid The username * @param string $password The new password * @return bool @@ -79,7 +79,7 @@ class OC_User_Dummy extends OC_User_Backend { } /** - * @brief Check if the password is correct + * Check if the password is correct * @param string $uid The username * @param string $password The password * @return string @@ -96,7 +96,7 @@ class OC_User_Dummy extends OC_User_Backend { } /** - * @brief Get a list of all users + * Get a list of all users * @param string $search * @param int $limit * @param int $offset @@ -109,7 +109,7 @@ class OC_User_Dummy extends OC_User_Backend { } /** - * @brief check if a user exists + * check if a user exists * @param string $uid the username * @return boolean */ diff --git a/lib/private/user/example.php b/lib/private/user/example.php index 4bf3652330e..db21d6f9e52 100644 --- a/lib/private/user/example.php +++ b/lib/private/user/example.php @@ -27,7 +27,7 @@ */ abstract class OC_User_Example extends OC_User_Backend { /** - * @brief Create a new user + * Create a new user * @param string $uid The username of the user to create * @param string $password The password of the new user * @return bool @@ -38,7 +38,7 @@ abstract class OC_User_Example extends OC_User_Backend { abstract public function createUser($uid, $password); /** - * @brief Set password + * Set password * @param string $uid The username * @param string $password The new password * @return bool @@ -48,7 +48,7 @@ abstract class OC_User_Example extends OC_User_Backend { abstract public function setPassword($uid, $password); /** - * @brief Check if the password is correct + * Check if the password is correct * @param string $uid The username * @param string $password The password * @return string @@ -59,7 +59,7 @@ abstract class OC_User_Example extends OC_User_Backend { abstract public function checkPassword($uid, $password); /** - * @brief get the user's home directory + * get the user's home directory * @param string $uid The username * @return string * diff --git a/lib/private/user/http.php b/lib/private/user/http.php index 67f7156b498..2bb8b4c864a 100644 --- a/lib/private/user/http.php +++ b/lib/private/user/http.php @@ -54,7 +54,7 @@ class OC_User_HTTP extends OC_User_Backend { } /** - * @brief Check if the password is correct + * Check if the password is correct * @param string $uid The username * @param string $password The password * @return string @@ -87,7 +87,7 @@ class OC_User_HTTP extends OC_User_Backend { } /** - * @brief check if a user exists + * check if a user exists * @param string $uid the username * @return boolean */ @@ -96,7 +96,7 @@ class OC_User_HTTP extends OC_User_Backend { } /** - * @brief get the user's home directory + * get the user's home directory * @param string $uid the username * @return string|false */ diff --git a/lib/private/user/interface.php b/lib/private/user/interface.php index e130e5b569c..4cdc47479a3 100644 --- a/lib/private/user/interface.php +++ b/lib/private/user/interface.php @@ -24,7 +24,7 @@ interface OC_User_Interface { /** - * @brief Check if backend implements actions + * Check if backend implements actions * @param $actions bitwise-or'ed actions * @return boolean * @@ -34,14 +34,14 @@ interface OC_User_Interface { public function implementsActions($actions); /** - * @brief delete a user + * delete a user * @param string $uid The username of the user to delete * @return bool */ public function deleteUser($uid); /** - * @brief Get a list of all users + * Get a list of all users * @return array an array of all uids * * Get a list of all users. @@ -49,21 +49,21 @@ interface OC_User_Interface { public function getUsers($search = '', $limit = null, $offset = null); /** - * @brief check if a user exists + * check if a user exists * @param string $uid the username * @return boolean */ public function userExists($uid); /** - * @brief get display name of the user + * get display name of the user * @param string $uid user ID of the user * @return string display name */ public function getDisplayName($uid); /** - * @brief Get a list of all display names + * Get a list of all display names * @return array an array of all displayNames (value) and the corresponding uids (key) * * Get a list of all display names and user ids. @@ -71,7 +71,7 @@ interface OC_User_Interface { public function getDisplayNames($search = '', $limit = null, $offset = null); /** - * @brief Check if a user list is available or not + * Check if a user list is available or not * @return boolean if users can be listed or not */ public function hasUserListings(); diff --git a/lib/private/util.php b/lib/private/util.php index 107dc6b9a9f..c018721afe3 100755 --- a/lib/private/util.php +++ b/lib/private/util.php @@ -13,7 +13,7 @@ class OC_Util { private static $fsSetup=false; /** - * @brief Can be set up + * Can be set up * @param string $user * @return boolean * @description configure the initial filesystem based on the configuration @@ -87,7 +87,7 @@ class OC_Util { } /** - * @brief check if a password is required for each public link + * check if a password is required for each public link * @return boolean */ public static function isPublicLinkPasswordRequired() { @@ -115,7 +115,7 @@ class OC_Util { } /** - * @brief copies the user skeleton files into the fresh user home files + * copies the user skeleton files into the fresh user home files * @param string $userDirectory */ public static function copySkeleton($userDirectory) { @@ -123,7 +123,7 @@ class OC_Util { } /** - * @brief copies a directory recursively + * copies a directory recursively * @param string $source * @param string $target * @return void @@ -153,7 +153,7 @@ class OC_Util { } /** - * @brief get the current installed version of ownCloud + * get the current installed version of ownCloud * @return array */ public static function getVersion() { @@ -162,7 +162,7 @@ class OC_Util { } /** - * @brief get the current installed version string of ownCloud + * get the current installed version string of ownCloud * @return string */ public static function getVersionString() { @@ -223,7 +223,7 @@ class OC_Util { } /** - * @brief add a javascript file + * add a javascript file * * @param string $application * @param string|null $file filename @@ -242,7 +242,7 @@ class OC_Util { } /** - * @brief add a css file + * add a css file * * @param string $application * @param string|null $file filename @@ -261,7 +261,7 @@ class OC_Util { } /** - * @brief Add a custom element to the header + * Add a custom element to the header * @param string $tag tag name of the element * @param array $attributes array of attributes for the element * @param string $text the text content for the element @@ -276,7 +276,7 @@ class OC_Util { } /** - * @brief formats a timestamp in the "right" way + * formats a timestamp in the "right" way * * @param int $timestamp * @param bool $dateOnly option to omit time from the result @@ -296,7 +296,7 @@ class OC_Util { } /** - * @brief check if the current server configuration is suitable for ownCloud + * check if the current server configuration is suitable for ownCloud * @return array arrays with error messages and hints */ public static function checkServer() { @@ -540,7 +540,7 @@ class OC_Util { /** - * @brief check if there are still some encrypted files stored + * check if there are still some encrypted files stored * @return boolean */ public static function encryptedFiles() { @@ -561,7 +561,7 @@ class OC_Util { } /** - * @brief check if a backup from the encryption keys exists + * check if a backup from the encryption keys exists * @return boolean */ public static function backupKeysExists() { @@ -582,7 +582,7 @@ class OC_Util { } /** - * @brief Check for correct file permissions of data directory + * Check for correct file permissions of data directory * @param string $dataDirectory * @return array arrays with error messages and hints */ @@ -655,7 +655,7 @@ class OC_Util { /** - * @brief Check if the app is enabled, redirects to home if not + * Check if the app is enabled, redirects to home if not * @param string $app * @return void */ @@ -682,7 +682,7 @@ class OC_Util { } /** - * @brief Check if the user is a admin, redirects to home if not + * Check if the user is a admin, redirects to home if not * @return void */ public static function checkAdminUser() { @@ -715,7 +715,7 @@ class OC_Util { } /** - * @brief Check if the user is a subadmin, redirects to home if not + * Check if the user is a subadmin, redirects to home if not * @return null|boolean $groups where the current user is subadmin */ public static function checkSubAdminUser() { @@ -728,7 +728,7 @@ class OC_Util { } /** - * @brief Redirect to the user default page + * Redirect to the user default page * @return void */ public static function redirectToDefaultPage() { @@ -752,7 +752,7 @@ class OC_Util { } /** - * @brief get an id unique for this instance + * get an id unique for this instance * @return string */ public static function getInstanceId() { @@ -766,7 +766,7 @@ class OC_Util { } /** - * @brief Static lifespan (in seconds) when a request token expires. + * Static lifespan (in seconds) when a request token expires. * @see OC_Util::callRegister() * @see OC_Util::isCallRegistered() * @description @@ -777,7 +777,7 @@ class OC_Util { public static $callLifespan = 3600; // 3600 secs = 1 hour /** - * @brief Register an get/post call. Important to prevent CSRF attacks. + * Register an get/post call. Important to prevent CSRF attacks. * @todo Write howto: CSRF protection guide * @return string Generated token. * @description @@ -802,7 +802,7 @@ class OC_Util { } /** - * @brief Check an ajax get/post call if the request token is valid. + * Check an ajax get/post call if the request token is valid. * @return boolean False if request token is not set or is invalid. * @see OC_Util::$callLifespan * @see OC_Util::callRegister() @@ -812,7 +812,7 @@ class OC_Util { } /** - * @brief Check an ajax get/post call if the request token is valid. Exit if not. + * Check an ajax get/post call if the request token is valid. Exit if not. * @todo Write howto * @return void */ @@ -823,7 +823,7 @@ class OC_Util { } /** - * @brief Public function to sanitize HTML + * Public function to sanitize HTML * * This function is used to sanitize HTML and should be applied on any * string or array of strings before displaying it on a web page. @@ -842,7 +842,7 @@ class OC_Util { } /** - * @brief Public function to encode url parameters + * Public function to encode url parameters * * This function is used to encode path to file before output. * Encoding is done according to RFC 3986 with one exception: @@ -858,7 +858,7 @@ class OC_Util { } /** - * @brief Check if the .htaccess file is working + * Check if the .htaccess file is working * @throws OC\HintException If the testfile can't get written. * @return bool * @description Check if the .htaccess file is working by creating a test @@ -906,7 +906,7 @@ class OC_Util { } /** - * @brief test if webDAV is working properly + * test if webDAV is working properly * @return bool * @description * The basic assumption is that if the server returns 401/Not Authenticated for an unauthenticated PROPFIND @@ -970,7 +970,7 @@ class OC_Util { } /** - * @brief Check if the PHP module fileinfo is loaded. + * Check if the PHP module fileinfo is loaded. * @return bool */ public static function fileInfoLoaded() { @@ -978,7 +978,7 @@ class OC_Util { } /** - * @brief Check if a PHP version older then 5.3.8 is installed. + * Check if a PHP version older then 5.3.8 is installed. * @return bool */ public static function isPHPoutdated() { @@ -986,7 +986,7 @@ class OC_Util { } /** - * @brief Check if the ownCloud server can connect to the internet + * Check if the ownCloud server can connect to the internet * @return bool */ public static function isInternetConnectionWorking() { @@ -1018,7 +1018,7 @@ class OC_Util { } /** - * @brief Check if the connection to the internet is disabled on purpose + * Check if the connection to the internet is disabled on purpose * @return string */ public static function isInternetConnectionEnabled(){ @@ -1026,7 +1026,7 @@ class OC_Util { } /** - * @brief clear all levels of output buffering + * clear all levels of output buffering * @return void */ public static function obEnd(){ @@ -1037,7 +1037,7 @@ class OC_Util { /** - * @brief Generates a cryptographic secure pseudo-random string + * Generates a cryptographic secure pseudo-random string * @param int $length of the random string * @return string * Please also update secureRNGAvailable if you change something here @@ -1074,7 +1074,7 @@ class OC_Util { } /** - * @brief Checks if a secure random number generator is available + * Checks if a secure random number generator is available * @return bool */ public static function secureRNGAvailable() { @@ -1226,7 +1226,7 @@ class OC_Util { } /** - * @brief Clear the opcode cache if one exists + * Clear the opcode cache if one exists * This is necessary for writing to the config file * in case the opcode cache does not re-validate files * @return void diff --git a/lib/private/vobject.php b/lib/private/vobject.php index e472429b23e..94e3470ff08 100644 --- a/lib/private/vobject.php +++ b/lib/private/vobject.php @@ -35,7 +35,7 @@ class OC_VObject{ } /** - * @brief Parses the VObject + * Parses the VObject * @param string $data VObject as string * @return Sabre\VObject\Reader|null */ @@ -54,7 +54,7 @@ class OC_VObject{ } /** - * @brief Escapes semicolons + * Escapes semicolons * @param array $value * @return string */ @@ -66,7 +66,7 @@ class OC_VObject{ } /** - * @brief Creates an array out of a multivalue property + * Creates an array out of a multivalue property * @param string $value * @return array */ @@ -112,7 +112,7 @@ class OC_VObject{ } /** - * @brief Add property to vobject + * Add property to vobject * @param object $name of property * @param object $value of property * @param array|object $parameters of property diff --git a/lib/public/iappconfig.php b/lib/public/iappconfig.php index 16c0752f073..d43eb70ee04 100644 --- a/lib/public/iappconfig.php +++ b/lib/public/iappconfig.php @@ -13,7 +13,7 @@ namespace OCP; */ interface IAppConfig { /** - * @brief check if a key is set in the appconfig + * check if a key is set in the appconfig * @param string $app * @param string $key * @return bool @@ -21,7 +21,7 @@ interface IAppConfig { public function hasKey($app, $key); /** - * @brief Gets the config value + * Gets the config value * @param string $app app * @param string $key key * @param string $default = null, default value if the key does not exist @@ -33,7 +33,7 @@ interface IAppConfig { public function getValue($app, $key, $default = null); /** - * @brief Deletes a key + * Deletes a key * @param string $app app * @param string $key key * @return bool @@ -43,7 +43,7 @@ interface IAppConfig { public function deleteKey($app, $key); /** - * @brief Get the available keys for an app + * Get the available keys for an app * @param string $app the app we are looking for * @return array an array of key names * @@ -62,7 +62,7 @@ interface IAppConfig { public function getValues($app, $key); /** - * @brief sets a value in the appconfig + * sets a value in the appconfig * @param string $app app * @param string $key key * @param string $value value @@ -73,7 +73,7 @@ interface IAppConfig { public function setValue($app, $key, $value); /** - * @brief Get all apps using the config + * Get all apps using the config * @return array an array of app ids * * This function returns a list of all apps that have at least one @@ -82,7 +82,7 @@ interface IAppConfig { public function getApps(); /** - * @brief Remove app from appconfig + * Remove app from appconfig * @param string $app app * @return bool * diff --git a/lib/public/iavatar.php b/lib/public/iavatar.php index fc7e8e79fed..1e80682c4f7 100644 --- a/lib/public/iavatar.php +++ b/lib/public/iavatar.php @@ -14,14 +14,14 @@ namespace OCP; interface IAvatar { /** - * @brief get the users avatar + * get the users avatar * @param int $size size in px of the avatar, avatars are square, defaults to 64 * @return boolean|\OC_Image containing the avatar or false if there's no image */ function get($size = 64); /** - * @brief sets the users avatar + * sets the users avatar * @param Image $data mixed imagedata or path to set a new avatar * @throws Exception if the provided file is not a jpg or png image * @throws Exception if the provided image is not valid @@ -31,7 +31,7 @@ interface IAvatar { function set($data); /** - * @brief remove the users avatar + * remove the users avatar * @return void */ function remove(); diff --git a/lib/public/iavatarmanager.php b/lib/public/iavatarmanager.php index b09b456a0da..1fd89405983 100644 --- a/lib/public/iavatarmanager.php +++ b/lib/public/iavatarmanager.php @@ -14,7 +14,7 @@ namespace OCP; interface IAvatarManager { /** - * @brief return a user specific instance of \OCP\IAvatar + * return a user specific instance of \OCP\IAvatar * @see \OCP\IAvatar * @param string $user the ownCloud user id * @return \OCP\IAvatar diff --git a/lib/public/il10n.php b/lib/public/il10n.php index 7649a1ea538..2c95ddfec18 100644 --- a/lib/public/il10n.php +++ b/lib/public/il10n.php @@ -75,9 +75,9 @@ interface IL10N { /** - * @brief find the best language + * find the best language * @param array|string $app details below - * @returns string language + * @return string language * * If $app is an array, ownCloud assumes that these are the available * languages. Otherwise ownCloud tries to find the files in the l10n diff --git a/lib/public/util.php b/lib/public/util.php index 929d86859a1..3166d4040d8 100644 --- a/lib/public/util.php +++ b/lib/public/util.php @@ -492,7 +492,7 @@ class Util { } /** - * @brief Generates a cryptographic secure pseudo-random string + * Generates a cryptographic secure pseudo-random string * @param int $length of the random string * @return string */ @@ -501,7 +501,7 @@ class Util { } /** - * @brief check if a password is required for each public link + * check if a password is required for each public link * @return boolean */ public static function isPublicLinkPasswordRequired() { |