Merge pull request #8283 from cakephp/master-doc-block-fixes

Add fully qualified namespaces to API doc links

src/Auth/BaseAuthorize.php

@@ -21,7 +21,7 @@
 /**
  * Abstract base authorization adapter for AuthComponent.
  *
- * @see AuthComponent::$authenticate
+ * @see \Cake\Controller\Component\AuthComponent::$authenticate
  */
 abstract class BaseAuthorize
 {

src/Auth/ControllerAuthorize.php

@@ -37,7 +37,7 @@
  * The above is simple implementation that would only authorize users of the
  * 'admin' role to access admin routing.
  *
- * @see AuthComponent::$authenticate
+ * @see \Cake\Controller\Component\AuthComponent::$authenticate
  */
 class ControllerAuthorize extends BaseAuthorize
 {

src/Auth/FormAuthenticate.php

@@ -33,7 +33,7 @@
  * When configuring FormAuthenticate you can pass in config to which fields, model and additional conditions
  * are used. See FormAuthenticate::$_config for more information.
  *
- * @see AuthComponent::$authenticate
+ * @see \Cake\Controller\Component\AuthComponent::$authenticate
  */
 class FormAuthenticate extends BaseAuthenticate
 {

src/Collection/Iterator/StoppableIterator.php

@@ -22,7 +22,7 @@
  * results.
  *
  * @internal
- * @see Collection::stopWhen()
+ * @see \Cake\Collection\Collection::stopWhen()
  */
 class StoppableIterator extends Collection
 {

src/Collection/Iterator/UnfoldIterator.php

@@ -22,7 +22,7 @@
  * of items by applying an function to each of the elements in this iterator.
  *
  * @internal
- * @see Collection::unfold()
+ * @see \Cake\Collection\Collection::unfold()
  */
 class UnfoldIterator extends IteratorIterator implements RecursiveIterator
 {

src/Console/ConsoleInputArgument.php

@@ -21,7 +21,7 @@
  * An object to represent a single argument used in the command line.
  * ConsoleOptionParser creates these when you use addArgument()
  *
- * @see ConsoleOptionParser::addArgument()
+ * @see \Cake\Console\ConsoleOptionParser::addArgument()
  */
 class ConsoleInputArgument
 {

src/Console/ConsoleInputOption.php

@@ -21,7 +21,7 @@
  * An object to represent a single option used in the command line.
  * ConsoleOptionParser creates these when you use addOption()
  *
- * @see ConsoleOptionParser::addOption()
+ * @see \Cake\Console\ConsoleOptionParser::addOption()
  */
 class ConsoleInputOption
 {

src/Console/ConsoleInputSubcommand.php

@@ -22,7 +22,7 @@
  * An object to represent a single subcommand used in the command line.
  * Created when you call ConsoleOptionParser::addSubcommand()
  *
- * @see ConsoleOptionParser::addSubcommand()
+ * @see \Cake\Console\ConsoleOptionParser::addSubcommand()
  */
 class ConsoleInputSubcommand
 {

src/Console/ConsoleOptionParser.php

@@ -76,23 +76,23 @@ class ConsoleOptionParser
     /**
      * Description text - displays before options when help is generated
      *
-     * @see ConsoleOptionParser::description()
+     * @see \Cake\Console\ConsoleOptionParser::description()
      * @var string
      */
     protected $_description = null;
 
     /**
      * Epilog text - displays after options when help is generated
      *
-     * @see ConsoleOptionParser::epilog()
+     * @see \Cake\Console\ConsoleOptionParser::epilog()
      * @var string
      */
     protected $_epilog = null;
 
     /**
      * Option definitions.
      *
-     * @see ConsoleOptionParser::addOption()
+     * @see \Cake\Console\ConsoleOptionParser::addOption()
      * @var array
      */
     protected $_options = [];
@@ -107,15 +107,15 @@ class ConsoleOptionParser
     /**
      * Positional argument definitions.
      *
-     * @see ConsoleOptionParser::addArgument()
+     * @see \Cake\Console\ConsoleOptionParser::addArgument()
      * @var array
      */
     protected $_args = [];
 
     /**
      * Subcommands for this Shell.
      *
-     * @see ConsoleOptionParser::addSubcommand()
+     * @see \Cake\Console\ConsoleOptionParser::addSubcommand()
      * @var array
      */
     protected $_subcommands = [];
@@ -430,7 +430,7 @@ public function addArgument($name, array $params = [])
      * The keys are used as the argument names, and the values as params for the argument.
      *
      * @param array $args Array of arguments to add.
-     * @see ConsoleOptionParser::addArgument()
+     * @see \Cake\Console\ConsoleOptionParser::addArgument()
      * @return $this
      */
     public function addArguments(array $args)
@@ -450,7 +450,7 @@ public function addArguments(array $args)
      * The keys are used as option names, and the values as params for the option.
      *
      * @param array $options Array of options to add.
-     * @see ConsoleOptionParser::addOption()
+     * @see \Cake\Console\ConsoleOptionParser::addOption()
      * @return $this
      */
     public function addOptions(array $options)

src/Console/Exception/StopException.php

@@ -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
 {

src/Controller/Component.php

@@ -54,7 +54,7 @@
  * is the subject of each event and can be fetched using Event::subject().
  *
  * @link http://book.cakephp.org/3.0/en/controllers/components.html
- * @see Controller::$components
+ * @see \Cake\Controller\Controller::$components
  */
 class Component implements EventListenerInterface
 {

src/Controller/Component/AuthComponent.php

@@ -190,7 +190,7 @@ class AuthComponent extends Component
      * Controller actions for which user validation is not required.
      *
      * @var array
-     * @see AuthComponent::allow()
+     * @see \Cake\Controller\Component\AuthComponent::allow()
      */
     public $allowedActions = [];
 
@@ -598,7 +598,7 @@ public function allow($actions = null)
      *
      * @param string|array $actions Controller action name or array of actions
      * @return void
-     * @see AuthComponent::allow()
+     * @see \Cake\Controller\Component\AuthComponent::allow()
      * @link http://book.cakephp.org/3.0/en/controllers/components/authentication.html#making-actions-require-authorization
      */
     public function deny($actions = null)

src/Controller/Component/RequestHandlerComponent.php

@@ -58,7 +58,7 @@ class RequestHandlerComponent extends Component
      * Contains the file extension parsed out by the Router
      *
      * @var string
-     * @see Router::extensions()
+     * @see \Cake\Routing\Router::extensions()
      */
     public $ext = null;
 
@@ -133,7 +133,7 @@ public function implementedEvents()
      *
      * @param array $config The config data.
      * @return void
-     * @see Router::extensions()
+     * @see \Cake\Routing\Router::extensions()
      */
     public function initialize(array $config)
     {
@@ -535,7 +535,7 @@ public function prefers($type = null)
      * @param string $type Type of response to send (e.g: 'ajax')
      * @param array $options Array of options to use
      * @return void
-     * @see RequestHandlerComponent::respondAs()
+     * @see \Cake\Controller\Component\RequestHandlerComponent::respondAs()
      */
     public function renderAs(Controller $controller, $type, array $options = [])
     {

src/Controller/Component/SecurityComponent.php

@@ -175,7 +175,7 @@ public function requireAuth($actions)
      * @param \Cake\Controller\Controller $controller Instantiating controller
      * @param string $error Error method
      * @return mixed If specified, controller blackHoleCallback's response, or no return otherwise
-     * @see SecurityComponent::$blackHoleCallback
+     * @see \Cake\Controller\Component\SecurityComponent::$blackHoleCallback
      * @link http://book.cakephp.org/3.0/en/controllers/components/security.html#handling-blackhole-callbacks
      * @throws \Cake\Network\Exception\BadRequestException
      */

src/Core/Configure.php

@@ -46,7 +46,7 @@ class Configure
      * Configured engine classes, used to load config files from resources
      *
      * @var array
-     * @see Configure::load()
+     * @see \Cake\Core\Configure::load()
      */
     protected static $_engines = [];
 

src/Core/Plugin.php

@@ -301,7 +301,7 @@ public static function configPath($plugin)
      *
      * @param string $plugin name of the plugin
      * @return mixed
-     * @see Plugin::load() for examples of bootstrap configuration
+     * @see \Cake\Core\Plugin::load() for examples of bootstrap configuration
      */
     public static function bootstrap($plugin)
     {

src/Database/Expression/FunctionExpression.php

@@ -95,7 +95,7 @@ public function name($name = null)
      * @param array $types associative array of types to be associated with the
      * passed arguments
      * @param bool $prepend Whether to prepend or append to the list of arguments
-     * @see FunctionExpression::__construct() for more details.
+     * @see \Cake\Database\Expression\FunctionExpression::__construct() for more details.
      * @return $this
      */
     public function add($params, $types = [], $prepend = false)

src/Database/Expression/QueryExpression.php

@@ -60,7 +60,7 @@ class QueryExpression implements ExpressionInterface, Countable
      * passed in $conditions.
      * @param string $conjunction the glue that will join all the string conditions at this
      * level of the expression tree. For example "AND", "OR", "XOR"...
-     * @see QueryExpression::add() for more details on $conditions and $types
+     * @see \Cake\Database\Expression\QueryExpression::add() for more details on $conditions and $types
      */
     public function __construct($conditions = [], $types = [], $conjunction = 'AND')
     {

src/Datasource/QueryTrait.php

@@ -39,7 +39,7 @@ trait QueryTrait
      * When set, query execution will be bypassed.
      *
      * @var \Cake\Datasource\ResultSetInterface
-     * @see setResult()
+     * @see \Cake\Datasource\QueryTrait::setResult()
      */
     protected $_results;
 

src/Datasource/RepositoryInterface.php

@@ -70,7 +70,7 @@ public function find($type = 'all', $options = []);
      * @throws \Cake\Datasource\Exception\RecordNotFoundException if the record with such id
      * could not be found
      * @return \Cake\Datasource\EntityInterface
-     * @see RepositoryInterface::find()
+     * @see \Cake\Datasource\RepositoryInterface::find()
      */
     public function get($primaryKey, $options = []);
 
@@ -110,7 +110,7 @@ public function updateAll($fields, $conditions);
      * @param mixed $conditions Conditions to be used, accepts anything Query::where()
      * can take.
      * @return int Count Returns the affected rows.
-     * @see RepositoryInterface::delete()
+     * @see \Cake\Datasource\RepositoryInterface::delete()
      */
     public function deleteAll($conditions);
 

src/Error/Debugger.php

@@ -174,7 +174,7 @@ public static function getInstance($class = null)
      * @param mixed $var The variable to dump.
      * @param int $depth The depth to output to. Defaults to 3.
      * @return void
-     * @see Debugger::exportVar()
+     * @see \Cake\Error\Debugger::exportVar()
      * @link http://book.cakephp.org/3.0/en/development/debugging.html#outputting-values
      */
     public static function dump($var, $depth = 3)
@@ -528,7 +528,7 @@ protected static function _array(array $var, $depth, $indent)
      * @param int $depth The current depth, used for tracking recursion.
      * @param int $indent The current indentation level.
      * @return string
-     * @see Debugger::exportVar()
+     * @see \Cake\Error\Debugger::exportVar()
      */
     protected static function _object($var, $depth, $indent)
     {

src/Error/ErrorHandler.php

@@ -80,7 +80,7 @@
  *
  * Would enable handling for all non Notice errors.
  *
- * @see ExceptionRenderer for more information on how to customize exception rendering.
+ * @see \Cake\Error\ExceptionRenderer for more information on how to customize exception rendering.
  */
 class ErrorHandler extends BaseErrorHandler
 {

src/I18n/RelativeTimeFormatter.php

@@ -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)
     {
@@ -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 = [])
     {
@@ -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 = [])
     {

src/Mailer/Mailer.php

@@ -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
 {