summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDamien Regad <dregad@mantisbt.org>2021-10-25 19:05:43 +0200
committerDamien Regad <dregad@mantisbt.org>2022-01-16 18:23:45 +0100
commitc89ce556bd5f60a9dc337a3c809163c20c4208a9 (patch)
treec12e3e1c38efa42301e63e677269279942609f91
parent9747b1a543f5e01d15f5c521ce98ae0c8a70bdad (diff)
downloadadodb-c89ce556bd5f60a9dc337a3c809163c20c4208a9.tar.gz
adodb-c89ce556bd5f60a9dc337a3c809163c20c4208a9.tar.bz2
adodb-c89ce556bd5f60a9dc337a3c809163c20c4208a9.zip
Fix reported errors in generated documentation
-rw-r--r--adodb-datadict.inc.php4
-rw-r--r--adodb-xmlschema.inc.php2
-rw-r--r--adodb-xmlschema03.inc.php2
-rw-r--r--datadict/datadict-postgres.inc.php19
-rw-r--r--drivers/adodb-firebird.inc.php6
-rw-r--r--drivers/adodb-oci8.inc.php17
-rw-r--r--perf/perf-mysql.inc.php4
-rw-r--r--perf/perf-postgres.inc.php2
8 files changed, 31 insertions, 25 deletions
diff --git a/adodb-datadict.inc.php b/adodb-datadict.inc.php
index c73d5f2a..9dfa07a6 100644
--- a/adodb-datadict.inc.php
+++ b/adodb-datadict.inc.php
@@ -507,7 +507,7 @@ class ADODB_DataDict {
* @param string $tabname table-name
* @param string $flds column-name and type for the changed column
* @param string $tableflds='' complete definition of the new table, eg. for postgres, default ''
- * @param array/string $tableoptions='' options for the new table see createTableSQL, default ''
+ * @param array|string $tableoptions='' options for the new table see createTableSQL, default ''
* @return array with SQL strings
*/
function alterColumnSQL($tabname, $flds, $tableflds='',$tableoptions='')
@@ -562,7 +562,7 @@ class ADODB_DataDict {
* @param string $tabname table-name
* @param string $flds column-name and type for the changed column
* @param string $tableflds='' complete definition of the new table, eg. for postgres, default ''
- * @param array/string $tableoptions='' options for the new table see createTableSQL, default ''
+ * @param array|string $tableoptions='' options for the new table see createTableSQL, default ''
* @return array with SQL strings
*/
function dropColumnSQL($tabname, $flds, $tableflds='',$tableoptions='')
diff --git a/adodb-xmlschema.inc.php b/adodb-xmlschema.inc.php
index 7b0916ab..2f1765f6 100644
--- a/adodb-xmlschema.inc.php
+++ b/adodb-xmlschema.inc.php
@@ -1206,7 +1206,7 @@ class dbQuerySet extends dbObject {
* @tutorial getting_started.pkg
*
* @author Richard Tango-Lowy & Dan Cech
- * @version $Revision: 1.12 $
+ * @version 1.12
*
* @package axmls
*/
diff --git a/adodb-xmlschema03.inc.php b/adodb-xmlschema03.inc.php
index ca68962a..2363a4a4 100644
--- a/adodb-xmlschema03.inc.php
+++ b/adodb-xmlschema03.inc.php
@@ -1320,7 +1320,7 @@ class dbQuerySet extends dbObject {
* @tutorial getting_started.pkg
*
* @author Richard Tango-Lowy & Dan Cech
- * @version $Revision: 1.62 $
+ * @version 1.62
*
* @package axmls
*/
diff --git a/datadict/datadict-postgres.inc.php b/datadict/datadict-postgres.inc.php
index d091fd4f..d403cee3 100644
--- a/datadict/datadict-postgres.inc.php
+++ b/datadict/datadict-postgres.inc.php
@@ -190,12 +190,15 @@ class ADODB2_postgres extends ADODB_DataDict
/**
* Change the definition of one column
*
- * Postgres can't do that on it's own, you need to supply the complete definition of the new table,
- * to allow, recreating the table and copying the content over to the new table
- * @param string $tabname table-name
- * @param string $flds column-name and type for the changed column
- * @param string $tableflds complete definition of the new table, eg. for postgres, default ''
- * @param array/ $tableoptions options for the new table see CreateTableSQL, default ''
+ * Postgres can't do that on its own, you need to supply the complete
+ * definition of the new table, to allow recreating the table and copying
+ * the content over to the new table.
+ *
+ * @param string $tabname table-name
+ * @param string $flds column-name and type for the changed column
+ * @param string $tableflds complete definition of the new table, e.g. for postgres, default ''
+ * @param array $tableoptions options for the new table {@see CreateTableSQL()}, default ''
+ *
* @return array with SQL strings
*/
function alterColumnSQL($tabname, $flds, $tableflds='', $tableoptions='')
@@ -294,7 +297,7 @@ class ADODB2_postgres extends ADODB_DataDict
* @param string $tabname table-name
* @param string $flds column-name and type for the changed column
* @param string $tableflds complete definition of the new table, eg. for postgres, default ''
- * @param array/ $tableoptions options for the new table see CreateTableSQL, default ''
+ * @param array $tableoptions options for the new table {@see CreateTableSQL}, default []
* @return array with SQL strings
*/
function dropColumnSQL($tabname, $flds, $tableflds='', $tableoptions='')
@@ -321,7 +324,7 @@ class ADODB2_postgres extends ADODB_DataDict
* @param string $tabname table-name
* @param string $dropflds column-names to drop
* @param string $tableflds complete definition of the new table, eg. for postgres
- * @param array/string $tableoptions options for the new table see CreateTableSQL, default ''
+ * @param array|string $tableoptions options for the new table see CreateTableSQL, default ''
* @return array with SQL strings
*/
function _recreate_copy_table($tabname, $dropflds, $tableflds, $tableoptions='')
diff --git a/drivers/adodb-firebird.inc.php b/drivers/adodb-firebird.inc.php
index e479077f..54e2620f 100644
--- a/drivers/adodb-firebird.inc.php
+++ b/drivers/adodb-firebird.inc.php
@@ -244,11 +244,11 @@ class ADODB_firebird extends ADOConnection {
/**
- * Commits a transaction
+ * Commits a transaction.
*
- * @param bool $ok set to false to rollback transaction, true to commit
+ * @param bool $ok false to rollback transaction, true to commit
*
- * @return true/false.
+ * @return bool
*/
public function commitTrans($ok=true)
{
diff --git a/drivers/adodb-oci8.inc.php b/drivers/adodb-oci8.inc.php
index 6df64359..9b251698 100644
--- a/drivers/adodb-oci8.inc.php
+++ b/drivers/adodb-oci8.inc.php
@@ -973,9 +973,12 @@ END;
/**
* Execute SQL
*
- * @param sql SQL statement to execute, or possibly an array holding prepared statement ($sql[0] will hold sql text)
- * @param [inputarr] holds the input data to bind to. Null elements will be set to null.
- * @return RecordSet or false
+ * @param string|array $sql SQL statement to execute, or possibly an array holding
+ * prepared statement ($sql[0] will hold sql text).
+ * @param array|false $inputarr holds the input data to bind to.
+ * Null elements will be set to null.
+ *
+ * @return ADORecordSet|false
*/
function Execute($sql,$inputarr=false)
{
@@ -1257,12 +1260,12 @@ END;
* $db->Parameter($stmt,$group,'group');
* $db->Execute($stmt);
*
- * @param $stmt Statement returned by Prepare() or PrepareSP().
+ * @param $stmt Statement returned by {@see Prepare()} or {@see PrepareSP()}.
* @param $var PHP variable to bind to
* @param $name Name of stored procedure variable name to bind to.
- * @param [$isOutput] Indicates direction of parameter 0/false=IN 1=OUT 2= IN/OUT. This is ignored in oci8.
- * @param [$maxLen] Holds an maximum length of the variable.
- * @param [$type] The data type of $var. Legal values depend on driver.
+ * @param bool $isOutput Indicates direction of parameter 0/false=IN 1=OUT 2= IN/OUT. This is ignored in oci8.
+ * @param int $maxLen Holds an maximum length of the variable.
+ * @param mixed $type The data type of $var. Legal values depend on driver.
*
* @link http://php.net/oci_bind_by_name
*/
diff --git a/perf/perf-mysql.inc.php b/perf/perf-mysql.inc.php
index dae44229..ed92c805 100644
--- a/perf/perf-mysql.inc.php
+++ b/perf/perf-mysql.inc.php
@@ -125,7 +125,7 @@ class perf_mysql extends adodb_perf{
/**
* Returns a list of table statuses.
- *
+ *
* @param string $orderby Unused (compatibility with parent method)
* @return string A formatted set of recordsets
*/
@@ -299,7 +299,7 @@ class perf_mysql extends adodb_perf{
var $optimizeTableHigh = 'OPTIMIZE TABLE %s';
/**
- * @see adodb_perf#optimizeTable
+ * @see adodb_perf::optimizeTable()
*/
function optimizeTable( $table, $mode = ADODB_OPT_LOW)
{
diff --git a/perf/perf-postgres.inc.php b/perf/perf-postgres.inc.php
index 5ca19449..16b767d2 100644
--- a/perf/perf-postgres.inc.php
+++ b/perf/perf-postgres.inc.php
@@ -102,7 +102,7 @@ class perf_postgres extends adodb_perf{
var $optimizeTableHigh = 'VACUUM ANALYZE %s';
/**
- * @see adodb_perf#optimizeTable
+ * @see adodb_perf::optimizeTable()
*/
function optimizeTable($table, $mode = ADODB_OPT_LOW)