docs: make comment more detailed

kenjis · kenjis · commit 82e27ba2eb20 · 2021-11-24T11:56:07.000+09:00
diff --git a/system/Database/BaseBuilder.php b/system/Database/BaseBuilder.php
@@ -264,7 +264,9 @@ class BaseBuilder
     /**
      * Constructor
      *
-     * @param array|string $tableName
+     * @param array|string $tableName tablename or tablenames with or without aliases
+     *
+     * Examples of $tableName: `mytable`, `jobs j`, `jobs j, users u`, `['jobs j','users u']`
      *
      * @throws DatabaseException
      */
diff --git a/system/Database/BaseConnection.php b/system/Database/BaseConnection.php
@@ -835,7 +835,7 @@ abstract protected function _transCommit(): bool;
     abstract protected function _transRollback(): bool;
 
     /**
-     * Returns an instance of the query builder for this connection.
+     * Returns a non-shared new instance of the query builder for this connection.
      *
      * @param array|string $tableName
      *

Original file line number	Diff line number	Diff line change
`@@ -264,7 +264,9 @@ class BaseBuilder`
`264`	`264`	`/**`
`265`	`265`	`* Constructor`
`266`	`266`	`*`
`267`		`- * @param array\|string $tableName`
	`267`	`+ * @param array\|string $tableName tablename or tablenames with or without aliases`
	`268`	`+ *`
	`269`	+ * Examples of $tableName: `mytable`, `jobs j`, `jobs j, users u`, `['jobs j','users u']`
`268`	`270`	`*`
`269`	`271`	`* @throws DatabaseException`
`270`	`272`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -835,7 +835,7 @@ abstract protected function _transCommit(): bool;`
`835`	`835`	`abstract protected function _transRollback(): bool;`
`836`	`836`
`837`	`837`	`/**`
`838`		`- * Returns an instance of the query builder for this connection.`
	`838`	`+ * Returns a non-shared new instance of the query builder for this connection.`
`839`	`839`	`*`
`840`	`840`	`* @param array\|string $tableName`
`841`	`841`	`*`