diff options
author | Lukas Reschke <lukas@statuscode.ch> | 2014-04-21 15:44:54 +0200 |
---|---|---|
committer | Lukas Reschke <lukas@statuscode.ch> | 2014-04-21 15:44:54 +0200 |
commit | e88731a477991f54120939724da3c8a455c48b97 (patch) | |
tree | b33e14f6bce285890135bce4bdd3ab8099d6819b /lib/private/migrate.php | |
parent | 4fe5ca1908757781872133c7140f4c8848e94ac6 (diff) | |
download | nextcloud-server-e88731a477991f54120939724da3c8a455c48b97.tar.gz nextcloud-server-e88731a477991f54120939724da3c8a455c48b97.zip |
Some more PHPDoc fixes
Diffstat (limited to 'lib/private/migrate.php')
-rw-r--r-- | lib/private/migrate.php | 39 |
1 files changed, 19 insertions, 20 deletions
diff --git a/lib/private/migrate.php b/lib/private/migrate.php index 3fb3e334ea2..5bcc11b061b 100644 --- a/lib/private/migrate.php +++ b/lib/private/migrate.php @@ -69,9 +69,9 @@ class OC_Migrate{ /** * @brief exports a user, or owncloud instance - * @param optional $uid string user id of user to export if export type is user, defaults to current - * @param ootional $type string type of export, defualts to user - * @param otional $path string path to zip output folder + * @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 * @return string on error, path to zip on success */ public static function export( $uid=null, $type='user', $path=null ) { @@ -192,11 +192,12 @@ class OC_Migrate{ } /** - * @brief imports a user, or owncloud instance - * @param $path string path to zip - * @param optional $type type of import (user or instance) - * @param optional $uid userid of new user - */ + * @brief 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 + * @return string + */ public static function import( $path, $type='user', $uid=null ) { $datadir = OC_Config::getValue( 'datadirectory' ); @@ -307,8 +308,8 @@ class OC_Migrate{ /** * @brief recursively deletes a directory - * @param string $dir string path of dir to delete - * $param optional $deleteRootToo bool delete the root directory + * @param string $dir path of dir to delete + * @param bool $deleteRootToo delete the root directory * @return bool */ private static function unlink_r( $dir, $deleteRootToo=true ) { @@ -406,7 +407,7 @@ class OC_Migrate{ /** * @brief generates json containing export info, and merges any data supplied - * @param optional $array array of data to include in the returned json + * @param array $array of data to include in the returned json * @return string */ static private function getExportInfo( $array=array() ) { @@ -430,8 +431,7 @@ class OC_Migrate{ /** * @brief connects to migration.db, or creates if not found - * @param $db optional path to migration.db, defaults to user data dir - * @param string $path + * @param string $path to migration.db, defaults to user data dir * @return bool whether the operation was successful */ static private function connectDB( $path=null ) { @@ -461,7 +461,7 @@ class OC_Migrate{ /** * @brief creates the tables in migration.db from an apps database.xml - * @param string $appid string id of the app + * @param string $appid id of the app * @return bool whether the operation was successful */ static private function createAppTables( $appid ) { @@ -499,7 +499,6 @@ class OC_Migrate{ /** * @brief tries to create the zip - * @param $path string path to zip destination * @return bool */ static private function createZip() { @@ -538,7 +537,7 @@ class OC_Migrate{ * @brief imports a new user * @param string $db string path to migration.db * @param $info object of migration info - * @param $uid optional uid to use + * @param string|null|int $uid uid to use * @return array of apps with import statuses, or false on failure. */ public static function importAppData( $db, $info, $uid=null ) { @@ -601,10 +600,10 @@ class OC_Migrate{ } - /* - * @brief creates a new user in the database - * @param $uid string user_id of the user to be created - * @param $hash string hash of the user to be created + /** + * creates a new user in the database + * @param string $uid user_id of the user to be created + * @param string $hash hash of the user to be created * @return bool result of user creation */ public static function createUser( $uid, $hash ) { |