Skip to content

Commit

Permalink
Cleaned a few more doc blocks
Browse files Browse the repository at this point in the history
  • Loading branch information
Mark Scherer committed Feb 17, 2016
1 parent 145f43c commit 770bfbf
Show file tree
Hide file tree
Showing 9 changed files with 98 additions and 98 deletions.
4 changes: 2 additions & 2 deletions src/Console/Exception/StopException.php
Expand Up @@ -18,8 +18,8 @@
/**
* Exception class for halting errors in console tasks
*
* @see Cake\Console\Shell::_stop()
* @see Cake\Console\Shell::error()
* @see \Cake\Console\Shell::_stop()
* @see \Cake\Console\Shell::error()
*/
class StopException extends Exception
{
Expand Down
6 changes: 3 additions & 3 deletions src/I18n/RelativeTimeFormatter.php
Expand Up @@ -31,7 +31,7 @@ class RelativeTimeFormatter
* @param \Cake\Chronos\ChronosInterface|null $other The datetime to compare against.
* @param bool $absolute removes time difference modifiers ago, after, etc
* @return string The difference between the two days in a human readable format
* @see Cake\Chronos\ChronosInterface::diffForHumans
* @see \Cake\Chronos\ChronosInterface::diffForHumans
*/
public function diffForHumans(ChronosInterface $date, ChronosInterface $other = null, $absolute = false)
{
Expand Down Expand Up @@ -88,7 +88,7 @@ public function diffForHumans(ChronosInterface $date, ChronosInterface $other =
* @param \DateTimeInterface $time The time instance to format.
* @param array $options Array of options.
* @return string Relative time string.
* @see Cake\I18n\Time::timeAgoInWords()
* @see \Cake\I18n\Time::timeAgoInWords()
*/
public function timeAgoInWords(DatetimeInterface $time, array $options = [])
{
Expand Down Expand Up @@ -273,7 +273,7 @@ protected function _diffData($futureTime, $pastTime, $backwards, $options)
* @param \DatetimeInterface $date The date to format.
* @param array $options Array of options.
* @return string Relative date string.
* @see Cake\I18n\Date::timeAgoInWords()
* @see \Cake\I18n\Date::timeAgoInWords()
*/
public function dateAgoInWords(DatetimeInterface $date, array $options = [])
{
Expand Down
60 changes: 30 additions & 30 deletions src/Mailer/Mailer.php
Expand Up @@ -79,36 +79,36 @@
* Our mailer could either be registered in the application bootstrap, or
* in the Table class' initialize() hook.
*
* @method Email to($email = null, $name = null)
* @method Email from($email = null, $name = null)
* @method Email sender($email = null, $name = null)
* @method Email replyTo($email = null, $name = null)
* @method Email readReceipt($email = null, $name = null)
* @method Email returnPath($email = null, $name = null)
* @method Email addTo($email, $name = null)
* @method Email cc($email = null, $name = null)
* @method Email addCc($email, $name = null)
* @method Email bcc($email = null, $name = null)
* @method Email addBcc($email, $name = null)
* @method Email charset($charset = null)
* @method Email headerCharset($charset = null)
* @method Email subject($subject = null)
* @method Email setHeaders(array $headers)
* @method Email addHeaders(array $headers)
* @method Email getHeaders(array $include = [])
* @method Email template($template = false, $layout = false)
* @method Email viewRender($viewClass = null)
* @method Email viewVars($viewVars = null)
* @method Email theme($theme = null)
* @method Email helpers($helpers = null)
* @method Email emailFormat($format = null)
* @method Email transport($name = null)
* @method Email messageId($message = null)
* @method Email domain($domain = null)
* @method Email attachments($attachments = null)
* @method Email addAttachments($attachments)
* @method Email message($type = null)
* @method Email profile($config = null)
* @method \Cake\Mailer\Email to($email = null, $name = null)
* @method \Cake\Mailer\Email from($email = null, $name = null)
* @method \Cake\Mailer\Email sender($email = null, $name = null)
* @method \Cake\Mailer\Email replyTo($email = null, $name = null)
* @method \Cake\Mailer\Email readReceipt($email = null, $name = null)
* @method \Cake\Mailer\Email returnPath($email = null, $name = null)
* @method \Cake\Mailer\Email addTo($email, $name = null)
* @method \Cake\Mailer\Email cc($email = null, $name = null)
* @method \Cake\Mailer\Email addCc($email, $name = null)
* @method \Cake\Mailer\Email bcc($email = null, $name = null)
* @method \Cake\Mailer\Email addBcc($email, $name = null)
* @method \Cake\Mailer\Email charset($charset = null)
* @method \Cake\Mailer\Email headerCharset($charset = null)
* @method \Cake\Mailer\Email subject($subject = null)
* @method \Cake\Mailer\Email setHeaders(array $headers)
* @method \Cake\Mailer\Email addHeaders(array $headers)
* @method \Cake\Mailer\Email getHeaders(array $include = [])
* @method \Cake\Mailer\Email template($template = false, $layout = false)
* @method \Cake\Mailer\Email viewRender($viewClass = null)
* @method \Cake\Mailer\Email viewVars($viewVars = null)
* @method \Cake\Mailer\Email theme($theme = null)
* @method \Cake\Mailer\Email helpers($helpers = null)
* @method \Cake\Mailer\Email emailFormat($format = null)
* @method \Cake\Mailer\Email transport($name = null)
* @method \Cake\Mailer\Email messageId($message = null)
* @method \Cake\Mailer\Email domain($domain = null)
* @method \Cake\Mailer\Email attachments($attachments = null)
* @method \Cake\Mailer\Email addAttachments($attachments)
* @method \Cake\Mailer\Email message($type = null)
* @method \Cake\Mailer\Email profile($config = null)
*/
abstract class Mailer implements EventListenerInterface
{
Expand Down
2 changes: 1 addition & 1 deletion src/Network/CorsBuilder.php
Expand Up @@ -24,7 +24,7 @@
*
* It is most convenient to get this object via `Request::cors()`.
*
* @see Cake\Network\Response::cors()
* @see \Cake\Network\Response::cors()
*/
class CorsBuilder
{
Expand Down
2 changes: 1 addition & 1 deletion src/ORM/LazyEagerLoader.php
Expand Up @@ -36,7 +36,7 @@ class LazyEagerLoader
*
* @param \Cake\Datasource\EntityInterface|array $entities a single entity or list of entities
* @param array $contain A `contain()` compatible array.
* @see Cake\ORM\Query\contain()
* @see \Cake\ORM\Query\contain()
* @param \Cake\ORM\Table $source The table to use for fetching the top level entities
* @return \Cake\Datasource\EntityInterface|array
*/
Expand Down
38 changes: 19 additions & 19 deletions src/ORM/Query.php
Expand Up @@ -33,39 +33,39 @@
* into a specific iterator that will be responsible for hydrating results if
* required.
*
* @see CollectionInterface For a full description of the collection methods supported by this class
* @method CollectionInterface each(callable $c) Passes each of the query results to the callable
* @method CollectionInterface filter(callable $c = null) Keeps the results using passing the callable test
* @method CollectionInterface reject(callable $c) Removes the results passing the callable test
* @see \Cake\Collection\CollectionInterface For a full description of the collection methods supported by this class
* @method \Cake\Collection\CollectionInterface each(callable $c) Passes each of the query results to the callable
* @method \Cake\Collection\CollectionInterface filter(callable $c = null) Keeps the results using passing the callable test
* @method \Cake\Collection\CollectionInterface reject(callable $c) Removes the results passing the callable test
* @method bool every(callable $c) Returns true if all the results pass the callable test
* @method bool some(callable $c) Returns true if at least one of the results pass the callable test
* @method CollectionInterface map(callable $c) Modifies each of the results using the callable
* @method \Cake\Collection\CollectionInterface map(callable $c) Modifies each of the results using the callable
* @method mixed reduce(callable $c, $zero = null) Folds all the results into a single value using the callable.
* @method CollectionInterface extract($field) Extracts a single column from each row
* @method \Cake\Collection\CollectionInterface extract($field) Extracts a single column from each row
* @method mixed max($field, $type = SORT_NUMERIC) Returns the maximum value for a single column in all the results.
* @method mixed min($field, $type = SORT_NUMERIC) Returns the minimum value for a single column in all the results.
* @method CollectionInterface groupBy(string|callable $field) In-memory group all results by the value of a column.
* @method CollectionInterface indexBy(string|callable $field) Returns the results indexed by the value of a column.
* @method \Cake\Collection\CollectionInterface groupBy(string|callable $field) In-memory group all results by the value of a column.
* @method \Cake\Collection\CollectionInterface indexBy(string|callable $field) Returns the results indexed by the value of a column.
* @method int countBy(string|callable $field) Returns the number of unique values for a column
* @method float sumOf(string|callable $field) Returns the sum of all values for a single column
* @method CollectionInterface shuffle() In-memory randomize the order the results are returned
* @method CollectionInterface sample($size = 10) In-memory shuffle the results and return a subset of them.
* @method CollectionInterface take($size = 1, $from = 0) In-memory limit and offset for the query results.
* @method CollectionInterface skip(int $howMany) Skips some rows from the start of the query result.
* @method \Cake\Collection\CollectionInterface shuffle() In-memory randomize the order the results are returned
* @method \Cake\Collection\CollectionInterface sample($size = 10) In-memory shuffle the results and return a subset of them.
* @method \Cake\Collection\CollectionInterface take($size = 1, $from = 0) In-memory limit and offset for the query results.
* @method \Cake\Collection\CollectionInterface skip(int $howMany) Skips some rows from the start of the query result.
* @method mixed last() Return the last row of the query result
* @method CollectionInterface append(array|Traversable $items) Appends more rows to the result of the query.
* @method CollectionInterface combine($k, $v, $g = null) Returns the values of the column $v index by column $k,
* @method \Cake\Collection\CollectionInterface append(array|Traversable $items) Appends more rows to the result of the query.
* @method \Cake\Collection\CollectionInterface combine($k, $v, $g = null) Returns the values of the column $v index by column $k,
* and grouped by $g.
* @method CollectionInterface nest($k, $p) Creates a tree structure by nesting the values of column $p into that
* @method \Cake\Collection\CollectionInterface nest($k, $p) Creates a tree structure by nesting the values of column $p into that
* with the same value for $k.
* @method array toArray() Returns a key-value array with the results of this query.
* @method array toList() Returns a numerically indexed array with the results of this query.
* @method CollectionInterface stopWhen(callable $c) Returns each row until the callable returns true.
* @method CollectionInterface zip(array|Traversable $c) Returns the first result of both the query and $c in an array,
* @method \Cake\Collection\CollectionInterface stopWhen(callable $c) Returns each row until the callable returns true.
* @method \Cake\Collection\CollectionInterface zip(array|\Traversable $c) Returns the first result of both the query and $c in an array,
* then the second results and so on.
* @method CollectionInterface zipWith(...$collections, callable $c) Returns each of the results out of calling $c
* @method \Cake\Collection\CollectionInterface zipWith(...$collections, callable $c) Returns each of the results out of calling $c
* with the first rows of the query and each of the items, then the second rows and so on.
* @method CollectionInterface chunk($size) Groups the results in arrays of $size rows each.
* @method \Cake\Collection\CollectionInterface chunk($size) Groups the results in arrays of $size rows each.
* @method bool isEmpty($size) Returns true if this query found no results.
*/
class Query extends DatabaseQuery implements JsonSerializable, QueryInterface
Expand Down
2 changes: 1 addition & 1 deletion src/ORM/RulesChecker.php
Expand Up @@ -23,7 +23,7 @@
*
* Adds ORM related features to the RulesChecker class.
*
* @see Cake\Datasource\RulesChecker
* @see \Cake\Datasource\RulesChecker
*/
class RulesChecker extends BaseRulesChecker
{
Expand Down

0 comments on commit 770bfbf

Please sign in to comment.