mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Fix more documentation failes 

Issue #7111
This commit is contained in:
Joas Schilling 2014-02-08 11:47:55 +01:00
parent 81031984a6
commit b330d07b51
19 changed files with 119 additions and 155 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
apps/files_encryption/lib/helper.php
View File

@ -423,8 +423,7 @@ class Helper {
/** /**
* @brief glob uses different pattern than regular expressions, escape glob pattern only * @brief glob uses different pattern than regular expressions, escape glob pattern only
* @param unescaped path * @param string $path unescaped path
* @param string $path
* @return escaped path * @return escaped path
*/ */
public static function escapeGlobPattern($path) { public static function escapeGlobPattern($path) {

17
apps/files_external/lib/config.php
View File

@ -263,17 +263,13 @@ class OC_Mount_Config {
/** /**
* Add a mount point to the filesystem * Add a mount point to the filesystem
* @param string Mount point * @param string $mountPoint Mount point
* @param string Backend class * @param string $class Backend class
* @param array Backend parameters for the class * @param array Backend parameters for the class
* @param string MOUNT_TYPE_GROUP | MOUNT_TYPE_USER * @param string $mountType MOUNT_TYPE_GROUP | MOUNT_TYPE_USER
* @param string User or group to apply mount to * @param string $applicable User or group to apply mount to
* @param bool Personal or system mount point i.e. is this being called from the personal or admin page * @param bool Personal or system mount point i.e. is this being called from the personal or admin page
* @param string $mountPoint * @return boolean
* @param string $class
* @param string $mountType
* @param string $applicable
* @return bool
*/ */
public static function addMountPoint($mountPoint, public static function addMountPoint($mountPoint,
$class, $class,
@ -347,8 +343,7 @@ class OC_Mount_Config {
/** /**
* Read the mount points in the config file into an array * Read the mount points in the config file into an array
* @param bool Personal or system config file * @param boolean $isPersonal Personal or system config file
* @param boolean $isPersonal
* @return array * @return array
*/ */
private static function readData($isPersonal) { private static function readData($isPersonal) {

2
apps/user_ldap/lib/wizard.php
View File

@ -240,9 +240,9 @@ class Wizard extends LDAPUtility {
/** /**
* @brief detects the available LDAP groups * @brief detects the available LDAP groups
* @returns the instance's WizardResult instance
* @param string $dbkey * @param string $dbkey
* @param string $confkey * @param string $confkey
* @returns the instance's WizardResult instance
*/ */
private function determineGroups($dbkey, $confkey, $testMemberOf = true) { private function determineGroups($dbkey, $confkey, $testMemberOf = true) {
if(!$this->checkRequirements(array('ldapHost', if(!$this->checkRequirements(array('ldapHost',

4
lib/private/appconfig.php
View File

@ -180,8 +180,6 @@ class OC_Appconfig {
* @param string $app app * @param string $app app
* @param string $key key * @param string $key key
* @return bool * @return bool
*
* Deletes a key.
*/ */
public static function deleteKey($app, $key) { public static function deleteKey($app, $key) {
// Boring! // Boring!
@ -213,8 +211,6 @@ class OC_Appconfig {
/** /**
* get multiply values, either the app or key can be used as wildcard by setting it to false * get multiply values, either the app or key can be used as wildcard by setting it to false
* *
* @param app
* @param key
* @param boolean $app * @param boolean $app
* @param string $key * @param string $key
* @return array * @return array

35
lib/private/archive.php
View File

@ -9,7 +9,6 @@
abstract class OC_Archive{ abstract class OC_Archive{
/** /**
* open any of the supported archive types * open any of the supported archive types
* @param string path
* @param string $path * @param string $path
* @return OC_Archive * @return OC_Archive
*/ */
@ -33,41 +32,39 @@ abstract class OC_Archive{
abstract function __construct($source); abstract function __construct($source);
/** /**
* add an empty folder to the archive * add an empty folder to the archive
* @param string path
* @param string $path * @param string $path
* @return bool * @return bool
*/ */
abstract function addFolder($path); abstract function addFolder($path);
/** /**
* add a file to the archive * add a file to the archive
* @param string path
* @param string source either a local file or string data
* @param string $path * @param string $path
* @param string source either a local file or string data
* @return bool * @return bool
*/ */
abstract function addFile($path, $source=''); abstract function addFile($path, $source='');
/** /**
* rename a file or folder in the archive * rename a file or folder in the archive
* @param string source * @param string $source
* @param string dest * @param string $dest
* @return bool * @return bool
*/ */
abstract function rename($source, $dest); abstract function rename($source, $dest);
/** /**
* get the uncompressed size of a file in the archive * get the uncompressed size of a file in the archive
* @param string path * @param string $path
* @return int * @return int
*/ */
abstract function filesize($path); abstract function filesize($path);
/** /**
* get the last modified time of a file in the archive * get the last modified time of a file in the archive
* @param string path * @param string $path
* @return int * @return int
*/ */
abstract function mtime($path); abstract function mtime($path);
/** /**
* get the files in a folder * get the files in a folder
* @param path * @param string $path
* @return array * @return array
*/ */
abstract function getFolder($path); abstract function getFolder($path);
@ -78,47 +75,47 @@ abstract class OC_Archive{
abstract function getFiles(); abstract function getFiles();
/** /**
* get the content of a file * get the content of a file
* @param string path * @param string $path
* @return string * @return string
*/ */
abstract function getFile($path); abstract function getFile($path);
/** /**
* extract a single file from the archive * extract a single file from the archive
* @param string path * @param string $path
* @param string dest * @param string $dest
* @return bool * @return bool
*/ */
abstract function extractFile($path, $dest); abstract function extractFile($path, $dest);
/** /**
* extract the archive * extract the archive
* @param string path * @param string $path
* @param string dest * @param string $dest
* @return bool * @return bool
*/ */
abstract function extract($dest); abstract function extract($dest);
/** /**
* check if a file or folder exists in the archive * check if a file or folder exists in the archive
* @param string path * @param string $path
* @return bool * @return bool
*/ */
abstract function fileExists($path); abstract function fileExists($path);
/** /**
* remove a file or folder from the archive * remove a file or folder from the archive
* @param string path * @param string $path
* @return bool * @return bool
*/ */
abstract function remove($path); abstract function remove($path);
/** /**
* get a file handler * get a file handler
* @param string path * @param string $path
* @param string mode * @param string $mode
* @return resource * @return resource
*/ */
abstract function getStream($path, $mode); abstract function getStream($path, $mode);
/** /**
* add a folder and all its content * add a folder and all its content
* @param string $path * @param string $path
* @param string source * @param string $source
* @return boolean|null * @return boolean|null
*/ */
function addRecursive($path, $source) { function addRecursive($path, $source) {

31
lib/private/archive/tar.php
View File

@ -30,7 +30,7 @@ class OC_Archive_TAR extends OC_Archive{
/** /**
* try to detect the type of tar compression * try to detect the type of tar compression
* @param string file * @param string $file
* @return integer * @return integer
*/ */
static public function getTarType($file) { static public function getTarType($file) {
@ -53,7 +53,7 @@ class OC_Archive_TAR extends OC_Archive{
/** /**
* add an empty folder to the archive * add an empty folder to the archive
* @param string path * @param string $path
* @return bool * @return bool
*/ */
function addFolder($path) { function addFolder($path) {
@ -80,8 +80,8 @@ class OC_Archive_TAR extends OC_Archive{
} }
/** /**
* add a file to the archive * add a file to the archive
* @param string path * @param string $path
* @param string source either a local file or string data * @param string $source either a local file or string data
* @return bool * @return bool
*/ */
function addFile($path, $source='') { function addFile($path, $source='') {
@ -103,8 +103,8 @@ class OC_Archive_TAR extends OC_Archive{
/** /**
* rename a file or folder in the archive * rename a file or folder in the archive
* @param string source * @param string $source
* @param string dest * @param string $dest
* @return bool * @return bool
*/ */
function rename($source, $dest) { function rename($source, $dest) {
@ -139,7 +139,7 @@ class OC_Archive_TAR extends OC_Archive{
/** /**
* get the uncompressed size of a file in the archive * get the uncompressed size of a file in the archive
* @param string path * @param string $path
* @return int * @return int
*/ */
function filesize($path) { function filesize($path) {
@ -158,7 +158,7 @@ class OC_Archive_TAR extends OC_Archive{
/** /**
* get the files in a folder * get the files in a folder
* @param path * @param string $path
* @return array * @return array
*/ */
function getFolder($path) { function getFolder($path) {
@ -201,7 +201,7 @@ class OC_Archive_TAR extends OC_Archive{
} }
/** /**
* get the content of a file * get the content of a file
* @param string path * @param string $path
* @return string * @return string
*/ */
function getFile($path) { function getFile($path) {
@ -209,8 +209,7 @@ class OC_Archive_TAR extends OC_Archive{
} }
/** /**
* extract a single file from the archive * extract a single file from the archive
* @param string path * @param string $path
* @param string dest
* @param string $dest * @param string $dest
* @return bool * @return bool
*/ */
@ -232,8 +231,6 @@ class OC_Archive_TAR extends OC_Archive{
} }
/** /**
* extract the archive * extract the archive
* @param string path
* @param string dest
* @param string $dest * @param string $dest
* @return bool * @return bool
*/ */
@ -242,7 +239,7 @@ class OC_Archive_TAR extends OC_Archive{
} }
/** /**
* check if a file or folder exists in the archive * check if a file or folder exists in the archive
* @param string path * @param string $path
* @return bool * @return bool
*/ */
function fileExists($path) { function fileExists($path) {
@ -270,7 +267,7 @@ class OC_Archive_TAR extends OC_Archive{
/** /**
* remove a file or folder from the archive * remove a file or folder from the archive
* @param string path * @param string $path
* @return bool * @return bool
*/ */
function remove($path) { function remove($path) {
@ -291,8 +288,8 @@ class OC_Archive_TAR extends OC_Archive{
} }
/** /**
* get a file handler * get a file handler
* @param string path * @param string $path
* @param string mode * @param string $mode
* @return resource * @return resource
*/ */
function getStream($path, $mode) { function getStream($path, $mode) {

33
lib/private/archive/zip.php
View File

@ -23,7 +23,7 @@ class OC_Archive_ZIP extends OC_Archive{
} }
/** /**
* add an empty folder to the archive * add an empty folder to the archive
* @param string path * @param string $path
* @return bool * @return bool
*/ */
function addFolder($path) { function addFolder($path) {
@ -31,8 +31,8 @@ class OC_Archive_ZIP extends OC_Archive{
} }
/** /**
* add a file to the archive * add a file to the archive
* @param string path * @param string $path
* @param string source either a local file or string data * @param string $source either a local file or string data
* @return bool * @return bool
*/ */
function addFile($path, $source='') { function addFile($path, $source='') {
@ -49,8 +49,8 @@ class OC_Archive_ZIP extends OC_Archive{
} }
/** /**
* rename a file or folder in the archive * rename a file or folder in the archive
* @param string source * @param string $source
* @param string dest * @param string $dest
* @return boolean|null * @return boolean|null
*/ */
function rename($source, $dest) { function rename($source, $dest) {
@ -60,7 +60,7 @@ class OC_Archive_ZIP extends OC_Archive{
} }
/** /**
* get the uncompressed size of a file in the archive * get the uncompressed size of a file in the archive
* @param string path * @param string $path
* @return int * @return int
*/ */
function filesize($path) { function filesize($path) {
@ -69,7 +69,7 @@ class OC_Archive_ZIP extends OC_Archive{
} }
/** /**
* get the last modified time of a file in the archive * get the last modified time of a file in the archive
* @param string path * @param string $path
* @return int * @return int
*/ */
function mtime($path) { function mtime($path) {
@ -77,7 +77,7 @@ class OC_Archive_ZIP extends OC_Archive{
} }
/** /**
* get the files in a folder * get the files in a folder
* @param path * @param string $path
* @return array * @return array
*/ */
function getFolder($path) { function getFolder($path) {
@ -107,7 +107,7 @@ class OC_Archive_ZIP extends OC_Archive{
} }
/** /**
* get the content of a file * get the content of a file
* @param string path * @param string $path
* @return string * @return string
*/ */
function getFile($path) { function getFile($path) {
@ -115,8 +115,7 @@ class OC_Archive_ZIP extends OC_Archive{
} }
/** /**
* extract a single file from the archive * extract a single file from the archive
* @param string path * @param string $path
* @param string dest
* @param string $dest * @param string $dest
* @return boolean|null * @return boolean|null
*/ */
@ -126,8 +125,7 @@ class OC_Archive_ZIP extends OC_Archive{
} }
/** /**
* extract the archive * extract the archive
* @param string path * @param string $path
* @param string dest
* @param string $dest * @param string $dest
* @return bool * @return bool
*/ */
@ -136,7 +134,7 @@ class OC_Archive_ZIP extends OC_Archive{
} }
/** /**
* check if a file or folder exists in the archive * check if a file or folder exists in the archive
* @param string path * @param string $path
* @return bool * @return bool
*/ */
function fileExists($path) { function fileExists($path) {
@ -144,7 +142,7 @@ class OC_Archive_ZIP extends OC_Archive{
} }
/** /**
* remove a file or folder from the archive * remove a file or folder from the archive
* @param string path * @param string $path
* @return bool * @return bool
*/ */
function remove($path) { function remove($path) {
@ -156,8 +154,8 @@ class OC_Archive_ZIP extends OC_Archive{
} }
/** /**
* get a file handler * get a file handler
* @param string path * @param string $path
* @param string mode * @param string $mode
* @return resource * @return resource
*/ */
function getStream($path, $mode) { function getStream($path, $mode) {
@ -194,6 +192,7 @@ class OC_Archive_ZIP extends OC_Archive{
} }
/** /**
* @param string $path
* @return string * @return string
*/ */
private function stripPath($path) { private function stripPath($path) {

3
lib/private/davclient.php
View File

@ -31,8 +31,7 @@ class OC_DAVClient extends \Sabre_DAV_Client {
/** /**
* @brief Sets the request timeout or 0 to disable timeout. * @brief Sets the request timeout or 0 to disable timeout.
* @param int timeout in seconds or 0 to disable * @param integer $timeout in seconds or 0 to disable
* @param integer $timeout
*/ */
public function setRequestTimeout($timeout) { public function setRequestTimeout($timeout) {
$this->requestTimeout = (int)$timeout; $this->requestTimeout = (int)$timeout;

3
lib/private/files/node/node.php
View File

@ -31,9 +31,8 @@ class Node implements \OCP\Files\Node {
/** /**
* @param \OC\Files\View $view * @param \OC\Files\View $view
* @param \OC\Files\Node\Root Root $root * @param \OC\Files\Node\Root $root
* @param string $path * @param string $path
* @param Root $root
*/ */
public function __construct($root, $view, $path) { public function __construct($root, $view, $path) {
$this->view = $view; $this->view = $view;

27
lib/private/installer.php
View File

@ -25,10 +25,6 @@
*/ */
class OC_Installer{ class OC_Installer{
/** /**
* @brief Installs an app
* @param $data array with all information
* @throws \Exception
* @returns integer
* *
* This function installs an app. All information needed are passed in the * This function installs an app. All information needed are passed in the
* associative array $data. * associative array $data.
@ -55,7 +51,11 @@ class OC_Installer{
* *
* It is the task of oc_app_install to create the tables and do whatever is * It is the task of oc_app_install to create the tables and do whatever is
* needed to get the app working. * needed to get the app working.
* @return string *
* @brief Installs an app
* @param array $data with all information
* @throws \Exception
* @return integer
*/ */
public static function installApp( $data = array()) { public static function installApp( $data = array()) {
$l = \OC_L10N::get('lib'); $l = \OC_L10N::get('lib');
@ -220,7 +220,7 @@ class OC_Installer{
/** /**
* @brief checks whether or not an app is installed * @brief checks whether or not an app is installed
* @param $app app * @param string $app app
* @returns true/false * @returns true/false
* *
* Checks whether or not an app is installed, i.e. registered in apps table. * Checks whether or not an app is installed, i.e. registered in apps table.
@ -236,7 +236,7 @@ class OC_Installer{
/** /**
* @brief Update an application * @brief Update an application
* @param $data array with all information * @param array $data with all information
* *
* This function installs an app. All information needed are passed in the * This function installs an app. All information needed are passed in the
* associative array $data. * associative array $data.
@ -270,7 +270,7 @@ class OC_Installer{
/** /**
* @brief Check if an update for the app is available * @brief Check if an update for the app is available
* @param $name name of the application * @param string $name name of the application
* @return string|false false or the version number of the update * @return string|false false or the version number of the update
* *
* The function will check if an update for a version is available * The function will check if an update for a version is available
@ -298,8 +298,8 @@ class OC_Installer{
/** /**
* @brief Check if app is already downloaded * @brief Check if app is already downloaded
* @param $name name of the application to remove * @param string $name name of the application to remove
* @returns true/false * @return boolean
* *
* The function will check if the app is already downloaded in the apps repository * The function will check if the app is already downloaded in the apps repository
*/ */
@ -316,7 +316,7 @@ class OC_Installer{
* @brief Removes an app * @brief Removes an app
* @param string $name name of the application to remove * @param string $name name of the application to remove
* @param $options array with options * @param $options array with options
* @returns true/false * @return boolean
* *
* This function removes an app. $options is an associative array. The * This function removes an app. $options is an associative array. The
* following keys are optional:ja * following keys are optional:ja
@ -395,8 +395,7 @@ class OC_Installer{
/** /**
* install an app already placed in the app folder * install an app already placed in the app folder
* @param string $app id of the app to install * @param string $app id of the app to install
* @returns array see OC_App::getAppInfo * @return integer
* @return string
*/ */
public static function installShippedApp($app) { public static function installShippedApp($app) {
//install the database //install the database
@ -431,7 +430,7 @@ class OC_Installer{
/** /**
* check the code of an app with some static code checks * check the code of an app with some static code checks
* @param string $folder the folder of the app to check * @param string $folder the folder of the app to check
* @returns true for app is o.k. and false for app is not o.k. * @return boolean true for app is o.k. and false for app is not o.k.
*/ */
public static function checkCode($appname, $folder) { public static function checkCode($appname, $folder) {

11
lib/private/ocs.php
View File

@ -35,13 +35,10 @@ class OC_OCS {
/** /**
* reads input date from get/post/cookies and converts the date to a special data-type * reads input date from get/post/cookies and converts the date to a special data-type
* *
* @param string HTTP method to read the key from * @param string $method HTTP method to read the key from
* @param string Parameter to read * @param string $key Parameter to read
* @param string Variable type to format data * @param string $type Variable type to format data
* @param mixed Default value to return if the key is not found * @param mixed $default Default value to return if the key is not found
* @param string $method
* @param string $key
* @param string $default
* @return string Data or if the key is not found and no default is set it will exit with a 400 Bad request * @return string Data or if the key is not found and no default is set it will exit with a 400 Bad request
*/ */
public static function readData($method, $key, $type = 'raw', $default = null) { public static function readData($method, $key, $type = 'raw', $default = null) {

15
lib/private/request.php
View File

@ -98,11 +98,10 @@ class OC_Request {
/** /**
* @brief Returns the script name * @brief Returns the script name
* @returns string the script name * @return string the script name
* *
* Returns the script name, even if the website uses one or more * Returns the script name, even if the website uses one or more
* reverse proxies * reverse proxies
* @return string
*/ */
public static function scriptName() { public static function scriptName() {
$name = $_SERVER['SCRIPT_NAME']; $name = $_SERVER['SCRIPT_NAME'];
@ -116,8 +115,7 @@ class OC_Request {
/** /**
* @brief get Path info from request * @brief get Path info from request
* @returns string Path info or false when not found * @return string Path info or false when not found
* @return string
*/ */
public static function getPathInfo() { public static function getPathInfo() {
if (array_key_exists('PATH_INFO', $_SERVER)) { if (array_key_exists('PATH_INFO', $_SERVER)) {
@ -141,8 +139,7 @@ class OC_Request {
/** /**
* @brief get Path info from request, not urldecoded * @brief get Path info from request, not urldecoded
* @returns string Path info or false when not found * @return string Path info or false when not found
* @return string
*/ */
public static function getRawPathInfo() { public static function getRawPathInfo() {
$requestUri = $_SERVER['REQUEST_URI']; $requestUri = $_SERVER['REQUEST_URI'];
@ -183,7 +180,7 @@ class OC_Request {
/** /**
* @brief Check if this is a no-cache request * @brief Check if this is a no-cache request
* @returns boolean true for no-cache * @return boolean true for no-cache
*/ */
static public function isNoCache() { static public function isNoCache() {
if (!isset($_SERVER['HTTP_CACHE_CONTROL'])) { if (!isset($_SERVER['HTTP_CACHE_CONTROL'])) {
@ -194,7 +191,7 @@ class OC_Request {
/** /**
* @brief Check if the requestor understands gzip * @brief Check if the requestor understands gzip
* @returns boolean true for gzip encoding supported * @return boolean true for gzip encoding supported
*/ */
static public function acceptGZip() { static public function acceptGZip() {
if (!isset($_SERVER['HTTP_ACCEPT_ENCODING'])) { if (!isset($_SERVER['HTTP_ACCEPT_ENCODING'])) {
@ -210,7 +207,7 @@ class OC_Request {
/** /**
* @brief Check if the requester sent along an mtime * @brief Check if the requester sent along an mtime
* @returns false or an mtime * @return false or an mtime
*/ */
static public function hasModificationTime () { static public function hasModificationTime () {
if (isset($_SERVER['HTTP_X_OC_MTIME'])) { if (isset($_SERVER['HTTP_X_OC_MTIME'])) {

5
lib/private/util.php
View File

@ -217,7 +217,7 @@ class OC_Util {
* @brief add a javascript file * @brief add a javascript file
* *
* @param string $application * @param string $application
* @param filename $file * @param mixed $file filename
* @return void * @return void
*/ */
public static function addScript( $application, $file = null ) { public static function addScript( $application, $file = null ) {
@ -236,7 +236,7 @@ class OC_Util {
* @brief add a css file * @brief add a css file
* *
* @param string $application * @param string $application
* @param filename $file * @param mixed $file filename
* @return void * @return void
*/ */
public static function addStyle( $application, $file = null ) { public static function addStyle( $application, $file = null ) {
@ -515,7 +515,6 @@ class OC_Util {
/** /**
* @brief Check for correct file permissions of data directory * @brief Check for correct file permissions of data directory
* @paran string $dataDirectory
* @param string $dataDirectory * @param string $dataDirectory
* @return array arrays with error messages and hints * @return array arrays with error messages and hints
*/ */

8
lib/public/app.php
View File

@ -85,6 +85,7 @@ class App {
* Register a Configuration Screen that should appear in the personal settings section. * Register a Configuration Screen that should appear in the personal settings section.
* @param $app string appid * @param $app string appid
* @param $page string page to be included * @param $page string page to be included
* @return void
*/ */
public static function registerPersonal( $app, $page ) { public static function registerPersonal( $app, $page ) {
\OC_App::registerPersonal( $app, $page ); \OC_App::registerPersonal( $app, $page );
@ -94,6 +95,7 @@ class App {
* Register a Configuration Screen that should appear in the Admin section. * Register a Configuration Screen that should appear in the Admin section.
* @param string $app string appid * @param string $app string appid
* @param string $page string page to be included * @param string $page string page to be included
* @return void
*/ */
public static function registerAdmin( $app, $page ) { public static function registerAdmin( $app, $page ) {
\OC_App::registerAdmin( $app, $page ); \OC_App::registerAdmin( $app, $page );
@ -111,7 +113,6 @@ class App {
/** /**
* checks whether or not an app is enabled * checks whether or not an app is enabled
* @param string
* @param string $app * @param string $app
* @return boolean * @return boolean
* *
@ -123,7 +124,8 @@ class App {
/** /**
* Check if the app is enabled, redirects to home if not * Check if the app is enabled, redirects to home if not
* @param string * @param string $app
* @return void
*/ */
public static function checkAppEnabled( $app ) { public static function checkAppEnabled( $app ) {
\OC_Util::checkAppEnabled( $app ); \OC_Util::checkAppEnabled( $app );
@ -131,7 +133,7 @@ class App {
/** /**
* Get the last version of the app, either from appinfo/version or from appinfo/info.xml * Get the last version of the app, either from appinfo/version or from appinfo/info.xml
* @param string * @param string $app
* @return string * @return string
*/ */
public static function getAppVersion( $app ) { public static function getAppVersion( $app ) {

4
lib/public/db.php
View File

@ -49,7 +49,7 @@ class DB {
/** /**
* Insert a row if a matching row doesn't exists. * Insert a row if a matching row doesn't exists.
* @param string $table string The table name (will replace *PREFIX*) to perform the replace on. * @param string $table The optional table name (will replace *PREFIX*) and add sequence suffix
* @param $input array * @param $input array
* *
* The input array if in the form: * The input array if in the form:
@ -70,7 +70,7 @@ class DB {
/** /**
* Gets last value of autoincrement * Gets last value of autoincrement
* @param string $table string The optional table name (will replace *PREFIX*) and add sequence suffix * @param string $table The optional table name (will replace *PREFIX*) and add sequence suffix
* @return string * @return string
* *
* \Doctrine\DBAL\Connection lastInsertID() * \Doctrine\DBAL\Connection lastInsertID()

17
lib/public/files.php
View File

@ -37,7 +37,7 @@ namespace OCP;
class Files { class Files {
/** /**
* Recusive deletion of folders * Recusive deletion of folders
* @param string path to the folder * @param string $path to the folder
* @return bool * @return bool
*/ */
static function rmdirr( $dir ) { static function rmdirr( $dir ) {
@ -46,7 +46,7 @@ class Files {
/** /**
* Get the mimetype form a local file * Get the mimetype form a local file
* @param string path * @param string $path
* @return string * @return string
* does NOT work for ownClouds filesystem, use OC_FileSystem::getMimeType instead * does NOT work for ownClouds filesystem, use OC_FileSystem::getMimeType instead
*/ */
@ -56,7 +56,7 @@ class Files {
/** /**
* Search for files by mimetype * Search for files by mimetype
* @param string mimetype * @param string $mimetype
* @return array * @return array
*/ */
static public function searchByMime( $mimetype ) { static public function searchByMime( $mimetype ) {
@ -65,8 +65,8 @@ class Files {
/** /**
* Copy the contents of one stream to another * Copy the contents of one stream to another
* @param resource source * @param resource $source
* @param resource target * @param resource $target
* @return int the number of bytes copied * @return int the number of bytes copied
*/ */
public static function streamCopy( $source, $target ) { public static function streamCopy( $source, $target ) {
@ -76,7 +76,7 @@ class Files {
/** /**
* Create a temporary file with an unique filename * Create a temporary file with an unique filename
* @param string postfix * @param string $postfix
* @return string * @return string
* *
* temporary files are automatically cleaned up after the script is finished * temporary files are automatically cleaned up after the script is finished
@ -97,8 +97,8 @@ class Files {
/** /**
* Adds a suffix to the name in case the file exists * Adds a suffix to the name in case the file exists
* @param string path * @param string $path
* @param string filename * @param string $filename
* @return string * @return string
*/ */
public static function buildNotExistingFileName( $path, $filename ) { public static function buildNotExistingFileName( $path, $filename ) {
@ -108,7 +108,6 @@ class Files {
/** /**
* Gets the Storage for an app - creates the needed folder if they are not * Gets the Storage for an app - creates the needed folder if they are not
* existant * existant
* @param string appid
* @param string $app * @param string $app
* @return \OC\Files\View * @return \OC\Files\View
*/ */

37
lib/public/share.php
View File

@ -750,12 +750,11 @@ class Share {
/** /**
* Set the permissions of an item for a specific user or group * Set the permissions of an item for a specific user or group
* @param string Item type * @param string $itemType Item type
* @param string Item source * @param string $itemSource Item source
* @param int SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK * @param int $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
* @param string User or group the item is being shared with * @param string $shareWith User or group the item is being shared with
* @param int CRUDS permissions * @param integer|null $permissions CRUDS
* @param integer|null $permissions
* @return boolean true on success or false on failure * @return boolean true on success or false on failure
*/ */
public static function setPermissions($itemType, $itemSource, $shareType, $shareWith, $permissions) { public static function setPermissions($itemType, $itemSource, $shareType, $shareWith, $permissions) {
@ -1382,20 +1381,15 @@ class Share {
/** /**
* Put shared item into the database * Put shared item into the database
* @param string Item type * @param string $itemType Item type
* @param string Item source * @param string $itemSource Item source
* @param int SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK * @param integer $shareType SHARE_TYPE_USER, SHARE_TYPE_GROUP, or SHARE_TYPE_LINK
* @param string User or group the item is being shared with * @param string $shareWith User or group the item is being shared with
* @param string User that is the owner of shared item * @param string $uidOwner User that is the owner of shared item
* @param int CRUDS permissions * @param int $permissions CRUDS permissions
* @param bool|array Parent folder target (optional) * @param bool|array, $parentFolder Parent folder target (optional)
* @param string token (optional) * @param string $token (optional)
* @param string name of the source item (optional) * @param string $itemSourceName name of the source item (optional)
* @param string $itemType
* @param string $itemSource
* @param integer $shareType
* @param integer $permissions
* @param string $itemSourceName
* @return bool Returns true on success or false on failure * @return bool Returns true on success or false on failure
*/ */
private static function put($itemType, $itemSource, $shareType, $shareWith, $uidOwner, private static function put($itemType, $itemSource, $shareType, $shareWith, $uidOwner,
@ -1966,8 +1960,7 @@ interface Share_Backend {
/** /**
* Converts the shared item sources back into the item in the specified format * Converts the shared item sources back into the item in the specified format
* @param array Shared items * @param array $items Shared items
* @param int Format
* @param integer $format * @param integer $format
* @return TODO * @return TODO
* *

13
lib/public/template.php
View File

@ -65,9 +65,8 @@ function preview_icon( $path ) {
/** /**
* Make publicpreview_icon available as a simple function * Make publicpreview_icon available as a simple function
* Returns the path to the preview of the image. * Returns the path to the preview of the image.
* @param string path of file * @param string $path of file
* @param string token * @param string $token
* @param string $path
* @return link to the preview * @return link to the preview
*/ */
function publicPreview_icon ( $path, $token ) { function publicPreview_icon ( $path, $token ) {
@ -78,7 +77,7 @@ function publicPreview_icon ( $path, $token ) {
* Make OC_Helper::humanFileSize available as a simple function * Make OC_Helper::humanFileSize available as a simple function
* Example: 2048 to 2 kB. * Example: 2048 to 2 kB.
* @param int size in bytes * @param int size in bytes
* @return string as string * @return string size as string
*/ */
function human_file_size( $bytes ) { function human_file_size( $bytes ) {
return(\human_file_size( $bytes )); return(\human_file_size( $bytes ));
@ -89,7 +88,7 @@ function human_file_size( $bytes ) {
* Return the relative date in relation to today. Returns something like "last hour" or "two month ago" * Return the relative date in relation to today. Returns something like "last hour" or "two month ago"
* @param int unix timestamp * @param int unix timestamp
* @param boolean date only * @param boolean date only
* @return OC_L10N_String readable interpretation of the timestamp * @return OC_L10N_String human readable interpretation of the timestamp
*/ */
function relative_modified_date( $timestamp, $dateOnly = false ) { function relative_modified_date( $timestamp, $dateOnly = false ) {
return(\relative_modified_date($timestamp, null, $dateOnly)); return(\relative_modified_date($timestamp, null, $dateOnly));
@ -100,7 +99,7 @@ function relative_modified_date( $timestamp, $dateOnly = false ) {
* Return a human readable outout for a file size. * Return a human readable outout for a file size.
* @deprecated human_file_size() instead * @deprecated human_file_size() instead
* @param integer size of a file in byte * @param integer size of a file in byte
* @return string readable interpretation of a file size * @return string human readable interpretation of a file size
*/ */
function simple_file_size($bytes) { function simple_file_size($bytes) {
return(\human_file_size($bytes)); return(\human_file_size($bytes));
@ -112,7 +111,7 @@ function simple_file_size($bytes) {
* @param $options the options * @param $options the options
* @param $selected which one is selected? * @param $selected which one is selected?
* @param array the parameters * @param array the parameters
* @return string options * @return string html options
*/ */
function html_select_options($options, $selected, $params=array()) { function html_select_options($options, $selected, $params=array()) {
return(\html_select_options($options, $selected, $params)); return(\html_select_options($options, $selected, $params));

6
lib/public/user.php
View File

@ -101,10 +101,8 @@ class User {
/** /**
* Check if the password is correct * Check if the password is correct
* @param string The username * @param string $uid The username
* @param string The password * @param string $password The password
* @param string $uid
* @param string $password
* @return string|false username on success, false otherwise * @return string|false username on success, false otherwise
* *
* Check if the password is correct without logging in the user * Check if the password is correct without logging in the user