Skip to content

Commit

Permalink
doc improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
cebe committed Jan 28, 2014
1 parent abceccf commit e27c387
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 14 deletions.
4 changes: 2 additions & 2 deletions framework/BaseYii.php
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@
/**
* BaseYii is the core helper class for the Yii framework.
*
* Do not use BaseYii directly. Instead, use its child class [[\Yii]] where
* you can customize methods of BaseYii.
* Do not use BaseYii directly. Instead, use its child class [[\Yii]] which you can replace to
* customize methods of BaseYii.
*
* @author Qiang Xue <[email protected]>
* @since 2.0
Expand Down
16 changes: 8 additions & 8 deletions framework/db/QueryBuilder.php
Original file line number Diff line number Diff line change
Expand Up @@ -561,7 +561,7 @@ public function getColumnType($type)
* @param array $columns
* @param boolean $distinct
* @param string $selectOption
* @return string the SELECT clause built from [[query]].
* @return string the SELECT clause built from [[Query::$select]].
*/
public function buildSelect($columns, $distinct = false, $selectOption = null)
{
Expand Down Expand Up @@ -595,7 +595,7 @@ public function buildSelect($columns, $distinct = false, $selectOption = null)

/**
* @param array $tables
* @return string the FROM clause built from [[query]].
* @return string the FROM clause built from [[Query::$from]].
*/
public function buildFrom($tables)
{
Expand Down Expand Up @@ -623,7 +623,7 @@ public function buildFrom($tables)
/**
* @param string|array $joins
* @param array $params the binding parameters to be populated
* @return string the JOIN clause built from [[query]].
* @return string the JOIN clause built from [[Query::$join]].
* @throws Exception if the $joins parameter is not in proper format
*/
public function buildJoin($joins, &$params)
Expand Down Expand Up @@ -663,7 +663,7 @@ public function buildJoin($joins, &$params)
/**
* @param string|array $condition
* @param array $params the binding parameters to be populated
* @return string the WHERE clause built from [[query]].
* @return string the WHERE clause built from [[Query::$where]].
*/
public function buildWhere($condition, &$params)
{
Expand All @@ -683,7 +683,7 @@ public function buildGroupBy($columns)
/**
* @param string|array $condition
* @param array $params the binding parameters to be populated
* @return string the HAVING clause built from [[query]].
* @return string the HAVING clause built from [[Query::$having]].
*/
public function buildHaving($condition, &$params)
{
Expand All @@ -693,7 +693,7 @@ public function buildHaving($condition, &$params)

/**
* @param array $columns
* @return string the ORDER BY clause built from [[query]].
* @return string the ORDER BY clause built from [[Query::$orderBy]].
*/
public function buildOrderBy($columns)
{
Expand All @@ -715,7 +715,7 @@ public function buildOrderBy($columns)
/**
* @param integer $limit
* @param integer $offset
* @return string the LIMIT and OFFSET clauses built from [[query]].
* @return string the LIMIT and OFFSET clauses built from [[Query::$limit]].
*/
public function buildLimit($limit, $offset)
{
Expand All @@ -732,7 +732,7 @@ public function buildLimit($limit, $offset)
/**
* @param array $unions
* @param array $params the binding parameters to be populated
* @return string the UNION clause built from [[query]].
* @return string the UNION clause built from [[Query::$union]].
*/
public function buildUnion($unions, &$params)
{
Expand Down
3 changes: 0 additions & 3 deletions framework/db/QueryInterface.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,6 @@
* Allows pagination via [[limit]] and [[offset]].
* Sorting is supported via [[orderBy]] and items can be limited to match some conditions using [[where]].
*
* By calling [[createCommand()]], we can get a [[Command]] instance which can be further
* used to perform/execute the DB query against a database.
*
* @author Qiang Xue <[email protected]>
* @author Carsten Brandt <[email protected]>
* @since 2.0
Expand Down
2 changes: 1 addition & 1 deletion framework/db/QueryTrait.php
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ trait QueryTrait
/**
* @var string|callable $column the name of the column by which the query results should be indexed by.
* This can also be a callable (e.g. anonymous function) that returns the index value based on the given
* row data. For more details, see [[indexBy()]]. This property is only used by [[all()]].
* row data. For more details, see [[indexBy()]]. This property is only used by [[QueryInterface::all()|all()]].
*/
public $indexBy;

Expand Down

0 comments on commit e27c387

Please sign in to comment.