Issue #2343127 by tadityar, harshil.maradiya, aphickey, bburg, ashutoshmishra: Docblock fixes for core/lib/Drupal/Core/Database/Query

8.0.x
Alex Pott 2015-02-16 23:38:20 +00:00
parent 62afca1f89
commit 8723012e3a
3 changed files with 10 additions and 8 deletions

View File

@ -278,8 +278,9 @@ class Condition implements ConditionInterface, \Countable {
* @param $operator * @param $operator
* The condition operator, such as "IN", "BETWEEN", etc. Case-sensitive. * The condition operator, such as "IN", "BETWEEN", etc. Case-sensitive.
* *
* @return * @return array
* The extra handling directives for the specified operator, or NULL. * The extra handling directives for the specified operator or an empty
* array if there are no extra handling directives.
*/ */
protected function mapConditionOperator($operator) { protected function mapConditionOperator($operator) {
// $specials does not use drupal_static as its value never changes. // $specials does not use drupal_static as its value never changes.

View File

@ -187,10 +187,10 @@ class Insert extends Query {
* Executes the insert query. * Executes the insert query.
* *
* @return * @return
* The last insert ID of the query, if one exists. If the query * The last insert ID of the query, if one exists. If the query was given
* was given multiple sets of values to insert, the return value is * multiple sets of values to insert, the return value is undefined. If no
* undefined. If no fields are specified, this method will do nothing and * fields are specified, this method will do nothing and return NULL. That
* return NULL. That makes it safe to use in multi-insert loops. * That makes it safe to use in multi-insert loops.
*/ */
public function execute() { public function execute() {
// If validation fails, simply return NULL. Note that validation routines // If validation fails, simply return NULL. Note that validation routines

View File

@ -135,8 +135,8 @@ class PagerSelectExtender extends SelectExtender {
* *
* The default if not specified is 10 items per page. * The default if not specified is 10 items per page.
* *
* @param $limit * @param int|false $limit
* An integer specifying the number of elements per page. If passed a false * An integer specifying the number of elements per page. If passed a false
* value (FALSE, 0, NULL), the pager is disabled. * value (FALSE, 0, NULL), the pager is disabled.
*/ */
public function limit($limit = 10) { public function limit($limit = 10) {
@ -161,6 +161,7 @@ class PagerSelectExtender extends SelectExtender {
* if both are set explicitly. * if both are set explicitly.
* *
* @param $element * @param $element
* Element ID that is used to differentiate different pager queries.
*/ */
public function element($element) { public function element($element) {
$this->element = $element; $this->element = $element;