adding PHPDoc

This commit is contained in:
Thomas Mueller 2013-06-27 23:34:36 +02:00
parent 77dc3964f8
commit 10951f9bd5
3 changed files with 11 additions and 4 deletions

View File

@ -49,10 +49,10 @@ class OC_DB {
/** /**
* @var \Doctrine\DBAL\Connection * @var \Doctrine\DBAL\Connection
*/ */
static private $connection; //the prefered connection to use, only Doctrine static private $connection; //the preferred connection to use, only Doctrine
static private $backend=null; static private $backend=null;
/** /**
* @var Doctrine * @var \Doctrine\DBAL\Connection
*/ */
static private $DOCTRINE=null; static private $DOCTRINE=null;
@ -652,7 +652,7 @@ class OC_DB {
/** /**
* check if a result is an error and throws an exception, works with \Doctrine\DBAL\DBALException * check if a result is an error and throws an exception, works with \Doctrine\DBAL\DBALException
* @param mixed $result * @param mixed $result
* @param string message * @param string $message
* @return void * @return void
* @throws DatabaseException * @throws DatabaseException
*/ */

View File

@ -7,6 +7,12 @@
*/ */
class OC_DB_MDB2SchemaWriter { class OC_DB_MDB2SchemaWriter {
/**
* @param $file
* @param \Doctrine\DBAL\Schema\AbstractSchemaManager $sm
* @return bool
*/
static public function saveSchemaToFile($file, $sm) { static public function saveSchemaToFile($file, $sm) {
$xml = new SimpleXMLElement('<database/>'); $xml = new SimpleXMLElement('<database/>');
$xml->addChild('name', OC_Config::getValue( "dbname", "owncloud" )); $xml->addChild('name', OC_Config::getValue( "dbname", "owncloud" ));

View File

@ -12,8 +12,9 @@ class OC_DB_Schema {
/** /**
* @brief saves database scheme to xml file * @brief saves database scheme to xml file
* @param \Doctrine\DBAL\Connection $conn
* @param string $file name of file * @param string $file name of file
* @param int $mode * @param int|string $mode
* @return bool * @return bool
* *
* TODO: write more documentation * TODO: write more documentation