From 95a6d7f8f5bf42d12cf6ab00015edc26b8d3ab87 Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Thu, 14 Nov 2019 09:13:15 +0100 Subject: [PATCH] Doxyen --- htdocs/core/class/coreobject.class.php | 8 ++++---- htdocs/core/db/DoliDB.class.php | 2 +- htdocs/core/db/mysqli.class.php | 14 +++++++------- htdocs/core/db/pgsql.class.php | 2 +- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/htdocs/core/class/coreobject.class.php b/htdocs/core/class/coreobject.class.php index cc87a791c0d..672697cd0a3 100644 --- a/htdocs/core/class/coreobject.class.php +++ b/htdocs/core/class/coreobject.class.php @@ -239,8 +239,8 @@ class CoreObject extends CommonObject /** * Function to update object or create or delete if needed * - * @param User $user user object - * @return < 0 if ko, > 0 if ok + * @param User $user User object + * @return int < 0 if KO, > 0 if OK */ public function update(User &$user) { @@ -280,7 +280,7 @@ class CoreObject extends CommonObject * Function to create object in database * * @param User $user user object - * @return < 0 if ko, > 0 if ok + * @return int < 0 if KO, > 0 if OK */ public function create(User &$user) { @@ -321,7 +321,7 @@ class CoreObject extends CommonObject * Function to delete object in database * * @param User $user user object - * @return < 0 if ko, > 0 if ok + * @return int < 0 if KO, > 0 if OK */ public function delete(User &$user) { diff --git a/htdocs/core/db/DoliDB.class.php b/htdocs/core/db/DoliDB.class.php index eb13095aaf0..29d77c089c0 100644 --- a/htdocs/core/db/DoliDB.class.php +++ b/htdocs/core/db/DoliDB.class.php @@ -29,7 +29,7 @@ require_once DOL_DOCUMENT_ROOT .'/core/db/Database.interface.php'; */ abstract class DoliDB implements Database { - /** @var resource Database handler */ + /** @var bool|resource Database handler */ public $db; /** @var string Database type */ public $type; diff --git a/htdocs/core/db/mysqli.class.php b/htdocs/core/db/mysqli.class.php index 902c3049cc4..a6f35a69fb9 100644 --- a/htdocs/core/db/mysqli.class.php +++ b/htdocs/core/db/mysqli.class.php @@ -40,7 +40,7 @@ class DoliDBMysqli extends DoliDB const LABEL='MySQL or MariaDB'; //! Version min database const VERSIONMIN='5.0.3'; - /** @var mysqli_result Resultset of last query */ + /** @var bool|mysqli_result Resultset of last query */ private $_results; /** @@ -187,12 +187,12 @@ class DoliDBMysqli extends DoliDB /** * Connect to server * - * @param string $host database server host - * @param string $login login - * @param string $passwd password - * @param string $name name of database (not used for mysql, used for pgsql) - * @param integer $port Port of database server - * @return mysqli Database access object + * @param string $host Database server host + * @param string $login Login + * @param string $passwd Password + * @param string $name Name of database (not used for mysql, used for pgsql) + * @param integer $port Port of database server + * @return mysqli Database access object * @see close() */ public function connect($host, $login, $passwd, $name, $port = 0) diff --git a/htdocs/core/db/pgsql.class.php b/htdocs/core/db/pgsql.class.php index 2388b60c7e1..28821f31725 100644 --- a/htdocs/core/db/pgsql.class.php +++ b/htdocs/core/db/pgsql.class.php @@ -401,7 +401,7 @@ class DoliDBPgsql extends DoliDB * @param string $passwd Password * @param string $name Name of database (not used for mysql, used for pgsql) * @param integer $port Port of database server - * @return false|resource Database access handler + * @return bool|resource Database access handler * @see close() */ public function connect($host, $login, $passwd, $name, $port = 0)