summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Pott2015-02-16 23:38:20 (GMT)
committerAlex Pott2015-02-16 23:38:20 (GMT)
commit8723012e3ae4b83e23ada008856d0a9cfa9a3c9e (patch)
tree2fcc950533771e3306b4c3887f8e3e3ec975762f
parent62afca1f894b69a0b38b393d924202115ff64fad (diff)
Issue #2343127 by tadityar, harshil.maradiya, aphickey, bburg, ashutoshmishra: Docblock fixes for core/lib/Drupal/Core/Database/Query
-rw-r--r--core/lib/Drupal/Core/Database/Query/Condition.php5
-rw-r--r--core/lib/Drupal/Core/Database/Query/Insert.php8
-rw-r--r--core/lib/Drupal/Core/Database/Query/PagerSelectExtender.php5
3 files changed, 10 insertions, 8 deletions
diff --git a/core/lib/Drupal/Core/Database/Query/Condition.php b/core/lib/Drupal/Core/Database/Query/Condition.php
index 987fba8..d32d00a 100644
--- a/core/lib/Drupal/Core/Database/Query/Condition.php
+++ b/core/lib/Drupal/Core/Database/Query/Condition.php
@@ -278,8 +278,9 @@ class Condition implements ConditionInterface, \Countable {
* @param $operator
* The condition operator, such as "IN", "BETWEEN", etc. Case-sensitive.
*
- * @return
- * The extra handling directives for the specified operator, or NULL.
+ * @return array
+ * The extra handling directives for the specified operator or an empty
+ * array if there are no extra handling directives.
*/
protected function mapConditionOperator($operator) {
// $specials does not use drupal_static as its value never changes.
diff --git a/core/lib/Drupal/Core/Database/Query/Insert.php b/core/lib/Drupal/Core/Database/Query/Insert.php
index 392c8c2..d9ddbc0 100644
--- a/core/lib/Drupal/Core/Database/Query/Insert.php
+++ b/core/lib/Drupal/Core/Database/Query/Insert.php
@@ -187,10 +187,10 @@ class Insert extends Query {
* Executes the insert query.
*
* @return
- * The last insert ID of the query, if one exists. If the query
- * was given multiple sets of values to insert, the return value is
- * undefined. If no fields are specified, this method will do nothing and
- * return NULL. That makes it safe to use in multi-insert loops.
+ * The last insert ID of the query, if one exists. If the query was given
+ * multiple sets of values to insert, the return value is undefined. If no
+ * fields are specified, this method will do nothing and return NULL. That
+ * That makes it safe to use in multi-insert loops.
*/
public function execute() {
// If validation fails, simply return NULL. Note that validation routines
diff --git a/core/lib/Drupal/Core/Database/Query/PagerSelectExtender.php b/core/lib/Drupal/Core/Database/Query/PagerSelectExtender.php
index 0f023e7..6bd6fac 100644
--- a/core/lib/Drupal/Core/Database/Query/PagerSelectExtender.php
+++ b/core/lib/Drupal/Core/Database/Query/PagerSelectExtender.php
@@ -135,8 +135,8 @@ class PagerSelectExtender extends SelectExtender {
*
* The default if not specified is 10 items per page.
*
- * @param $limit
- * An integer specifying the number of elements per page. If passed a false
+ * @param int|false $limit
+ * An integer specifying the number of elements per page. If passed a false
* value (FALSE, 0, NULL), the pager is disabled.
*/
public function limit($limit = 10) {
@@ -161,6 +161,7 @@ class PagerSelectExtender extends SelectExtender {
* if both are set explicitly.
*
* @param $element
+ * Element ID that is used to differentiate different pager queries.
*/
public function element($element) {
$this->element = $element;