Commit d386581c authored by jhodgdon's avatar jhodgdon

Issue #2212437 by longwave, Alumei: Fix up docs for Select db classes

parent bccc4328
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
/** /**
* @file * @file
* Definition of Drupal\Core\Database\Query\Query * Contains \Drupal\Core\Database\Query\Query.
*/ */
namespace Drupal\Core\Database\Query; namespace Drupal\Core\Database\Query;
...@@ -106,6 +106,9 @@ public function __clone() { ...@@ -106,6 +106,9 @@ public function __clone() {
/** /**
* Runs the query against the database. * Runs the query against the database.
*
* @return \Drupal\Core\Database\StatementInterface|null
* A prepared statement, or NULL if the query is not valid.
*/ */
abstract protected function execute(); abstract protected function execute();
...@@ -115,7 +118,7 @@ public function __clone() { ...@@ -115,7 +118,7 @@ public function __clone() {
* The toString operation is how we compile a query object to a prepared * The toString operation is how we compile a query object to a prepared
* statement. * statement.
* *
* @return * @return string
* A prepared statement query string for this object. * A prepared statement query string for this object.
*/ */
abstract public function __toString(); abstract public function __toString();
...@@ -131,7 +134,7 @@ public function uniqueIdentifier() { ...@@ -131,7 +134,7 @@ public function uniqueIdentifier() {
* Gets the next placeholder value for this query object. * Gets the next placeholder value for this query object.
* *
* @return int * @return int
* Next placeholder value. * The next placeholder value.
*/ */
public function nextPlaceholder() { public function nextPlaceholder() {
return $this->nextPlaceholder++; return $this->nextPlaceholder++;
...@@ -151,8 +154,7 @@ public function nextPlaceholder() { ...@@ -151,8 +154,7 @@ public function nextPlaceholder() {
* @param $comment * @param $comment
* The comment string to be inserted into the query. * The comment string to be inserted into the query.
* *
* @return \Drupal\Core\Database\Query\Query * @return $this
* The called object.
*/ */
public function comment($comment) { public function comment($comment) {
$this->comments[] = $comment; $this->comments[] = $comment;
...@@ -171,7 +173,7 @@ public function comment($comment) { ...@@ -171,7 +173,7 @@ public function comment($comment) {
* $comments =& $query->getComments(); * $comments =& $query->getComments();
* @endcode * @endcode
* *
* @return * @return array
* A reference to the comments array structure. * A reference to the comments array structure.
*/ */
public function &getComments() { public function &getComments() {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment