Merge pull request #9248 from ravage84/3.x-docblocks-superfluous

Remove superfluous stuff from doc blocks
cakephp · Aug 10, 2016 · 2ccbfcc · 2ccbfcc
2 parents 4d1c067 + f05e7e7
commit 2ccbfcc
Show file tree

Hide file tree

Showing 370 changed files with 82 additions and 479 deletions.
diff --git a/src/Auth/AbstractPasswordHasher.php b/src/Auth/AbstractPasswordHasher.php
@@ -18,7 +18,6 @@
 
 /**
  * Abstract password hashing class
- *
  */
 abstract class AbstractPasswordHasher
 {

diff --git a/src/Auth/BaseAuthenticate.php b/src/Auth/BaseAuthenticate.php
@@ -22,7 +22,6 @@
 
 /**
  * Base Authentication class with common methods and properties.
- *
  */
 abstract class BaseAuthenticate implements EventListenerInterface
 {

diff --git a/src/Auth/DefaultPasswordHasher.php b/src/Auth/DefaultPasswordHasher.php
@@ -16,7 +16,6 @@
 
 /**
  * Default password hashing class.
- *
  */
 class DefaultPasswordHasher extends AbstractPasswordHasher
 {

diff --git a/src/Auth/FallbackPasswordHasher.php b/src/Auth/FallbackPasswordHasher.php
@@ -18,7 +18,6 @@
  * A password hasher that can use multiple different hashes where only
  * one is the preferred one. This is useful when trying to migrate an
  * existing database of users from one password type to another.
- *
  */
 class FallbackPasswordHasher extends AbstractPasswordHasher
 {

diff --git a/src/Auth/PasswordHasherFactory.php b/src/Auth/PasswordHasherFactory.php
@@ -19,7 +19,6 @@
 
 /**
  * Builds password hashing objects
- *
  */
 class PasswordHasherFactory
 {

diff --git a/src/Auth/WeakPasswordHasher.php b/src/Auth/WeakPasswordHasher.php
@@ -22,7 +22,6 @@
  * Password hashing class that use weak hashing algorithms. This class is
  * intended only to be used with legacy databases where passwords have
  * not been migrated to a stronger algorithm yet.
- *
  */
 class WeakPasswordHasher extends AbstractPasswordHasher
 {

diff --git a/src/Cache/CacheEngine.php b/src/Cache/CacheEngine.php
@@ -19,7 +19,6 @@
 
 /**
  * Storage engine for CakePHP caching
- *
  */
 abstract class CacheEngine
 {

diff --git a/src/Cache/Engine/ApcEngine.php b/src/Cache/Engine/ApcEngine.php
@@ -19,7 +19,6 @@
 
 /**
  * APC storage engine for cache
- *
  */
 class ApcEngine extends CacheEngine
 {

diff --git a/src/Cache/Engine/FileEngine.php b/src/Cache/Engine/FileEngine.php
@@ -29,7 +29,6 @@
  * engine available, or have content which is not performance sensitive.
  *
  * You can configure a FileEngine cache, using Cache::config()
- *
  */
 class FileEngine extends CacheEngine
 {

diff --git a/src/Cache/Engine/MemcachedEngine.php b/src/Cache/Engine/MemcachedEngine.php
@@ -27,7 +27,6 @@
  * support of binary protocol, and igbinary serialization
  * (if memcached extension compiled with --enable-igbinary)
  * Compressed keys can also be incremented/decremented
- *
  */
 class MemcachedEngine extends CacheEngine
 {

diff --git a/src/Cache/Engine/RedisEngine.php b/src/Cache/Engine/RedisEngine.php
@@ -21,7 +21,6 @@
 
 /**
  * Redis storage engine for cache.
- *
  */
 class RedisEngine extends CacheEngine
 {

diff --git a/src/Collection/CollectionInterface.php b/src/Collection/CollectionInterface.php
@@ -21,7 +21,6 @@
  * Describes the methods a Collection should implement. A collection is an immutable
  * list of elements exposing a number of traversing and extracting method for
  * generating other collections.
- *
  */
 interface CollectionInterface extends Iterator, JsonSerializable
 {

diff --git a/src/Collection/Iterator/NestIterator.php b/src/Collection/Iterator/NestIterator.php
@@ -21,7 +21,6 @@
 /**
  * A type of collection that is aware of nested items and exposes methods to
  * check or retrieve them
- *
  */
 class NestIterator extends Collection implements RecursiveIterator
 {

diff --git a/src/Collection/Iterator/TreeIterator.php b/src/Collection/Iterator/TreeIterator.php
@@ -21,7 +21,6 @@
 /**
  * A Recursive iterator used to flatten nested structures and also exposes
  * all Collection methods
- *
  */
 class TreeIterator extends RecursiveIteratorIterator
 {

diff --git a/src/Collection/Iterator/TreePrinter.php b/src/Collection/Iterator/TreePrinter.php
@@ -20,7 +20,6 @@
 /**
  * Iterator for flattening elements in a tree structure while adding some
  * visual markers for their relative position in the tree
- *
  */
 class TreePrinter extends RecursiveIteratorIterator
 {

diff --git a/src/Collection/Iterator/ZipIterator.php b/src/Collection/Iterator/ZipIterator.php
@@ -41,7 +41,6 @@
  *  });
  *  $iterator->toList(); // Returns [4, 6]
  * ```
- *
  */
 class ZipIterator extends MultipleIterator implements CollectionInterface, Serializable
 {

diff --git a/src/Console/ConsoleInput.php b/src/Console/ConsoleInput.php
@@ -16,7 +16,6 @@
 
 /**
  * Object wrapper for interacting with stdin
- *
  */
 class ConsoleInput
 {

diff --git a/src/Console/ConsoleOptionParser.php b/src/Console/ConsoleOptionParser.php
@@ -68,7 +68,6 @@
  *
  * By providing help text for your positional arguments and named arguments, the ConsoleOptionParser
  * can generate a help display for you. You can view the help for shells by using the `--help` or `-h` switch.
- *
  */
 class ConsoleOptionParser
 {

diff --git a/src/Console/ConsoleOutput.php b/src/Console/ConsoleOutput.php
@@ -40,7 +40,6 @@
  * This would create orange 'Overwrite:' text, while the rest of the text would remain the normal color.
  * See ConsoleOutput::styles() to learn more about defining your own styles. Nested styles are not supported
  * at this time.
- *
  */
 class ConsoleOutput
 {

diff --git a/src/Console/Exception/ConsoleException.php b/src/Console/Exception/ConsoleException.php
@@ -18,7 +18,6 @@
 /**
  * Exception class for Console libraries.  This exception will be thrown from Console library
  * classes when they encounter an error.
- *
  */
 class ConsoleException extends Exception
 {

diff --git a/src/Console/Exception/MissingHelperException.php b/src/Console/Exception/MissingHelperException.php
@@ -16,7 +16,6 @@
 
 /**
  * Used when a Helper cannot be found.
- *
  */
 class MissingHelperException extends Exception
 {

diff --git a/src/Console/Exception/MissingShellException.php b/src/Console/Exception/MissingShellException.php
@@ -16,7 +16,6 @@
 
 /**
  * Used when a shell cannot be found.
- *
  */
 class MissingShellException extends Exception
 {

diff --git a/src/Console/Exception/MissingShellMethodException.php b/src/Console/Exception/MissingShellMethodException.php
@@ -16,7 +16,6 @@
 
 /**
  * Used when a shell method cannot be found.
- *
  */
 class MissingShellMethodException extends Exception
 {

diff --git a/src/Console/Exception/MissingTaskException.php b/src/Console/Exception/MissingTaskException.php
@@ -16,7 +16,6 @@
 
 /**
  * Used when a Task cannot be found.
- *
  */
 class MissingTaskException extends Exception
 {

diff --git a/src/Controller/Exception/MissingComponentException.php b/src/Controller/Exception/MissingComponentException.php
@@ -16,7 +16,6 @@
 
 /**
  * Used when a component cannot be found.
- *
  */
 class MissingComponentException extends Exception
 {

diff --git a/src/Core/ClassLoader.php b/src/Core/ClassLoader.php
@@ -15,7 +15,6 @@
 
 /**
  * ClassLoader
- *
  */
 class ClassLoader
 {

diff --git a/src/Core/Configure/Engine/PhpConfig.php b/src/Core/Configure/Engine/PhpConfig.php
@@ -24,7 +24,6 @@
  *
  * Files compatible with PhpConfig should return an array that
  * contains all of the configuration data contained in the file.
- *
  */
 class PhpConfig implements ConfigEngineInterface
 {

diff --git a/src/Core/Exception/Exception.php b/src/Core/Exception/Exception.php
@@ -16,7 +16,6 @@
 
 /**
  * Base class that all CakePHP Exceptions extend.
- *
  */
 class Exception extends RuntimeException
 {

diff --git a/src/Core/Exception/MissingPluginException.php b/src/Core/Exception/MissingPluginException.php
@@ -14,7 +14,6 @@
 
 /**
  * Exception raised when a plugin could not be found
- *
  */
 class MissingPluginException extends Exception
 {

diff --git a/src/Database/Driver.php b/src/Database/Driver.php
@@ -20,7 +20,6 @@
 /**
  * Represents a database diver containing all specificities for
  * a database engine including its SQL dialect
- *
  */
 abstract class Driver
 {

diff --git a/src/Database/Schema/CachedCollection.php b/src/Database/Schema/CachedCollection.php
@@ -19,7 +19,6 @@
 
 /**
  * Extends the schema collection class to provide caching
- *
  */
 class CachedCollection extends Collection
 {

diff --git a/src/Datasource/Exception/InvalidPrimaryKeyException.php b/src/Datasource/Exception/InvalidPrimaryKeyException.php
@@ -18,7 +18,6 @@
 
 /**
  * Exception raised when the provided primary key does not match the table primary key
- *
  */
 class InvalidPrimaryKeyException extends RuntimeException
 {

diff --git a/src/Datasource/Exception/MissingDatasourceException.php b/src/Datasource/Exception/MissingDatasourceException.php
@@ -16,7 +16,6 @@
 
 /**
  * Used when a datasource cannot be found.
- *
  */
 class MissingDatasourceException extends Exception
 {

diff --git a/src/Datasource/Exception/MissingModelException.php b/src/Datasource/Exception/MissingModelException.php
@@ -18,7 +18,6 @@
 
 /**
  * Used when a model cannot be found.
- *
  */
 class MissingModelException extends Exception
 {

diff --git a/src/Datasource/Exception/RecordNotFoundException.php b/src/Datasource/Exception/RecordNotFoundException.php
@@ -18,7 +18,6 @@
 
 /**
  * Exception raised when a particular record was not found
- *
  */
 class RecordNotFoundException extends RuntimeException
 {

diff --git a/src/Datasource/QueryTrait.php b/src/Datasource/QueryTrait.php
@@ -21,7 +21,6 @@
 /**
  * Contains the characteristics for an object that is attached to a repository and
  * can retrieve results based on any criteria.
- *
  */
 trait QueryTrait
 {

diff --git a/src/Datasource/ResultSetInterface.php b/src/Datasource/ResultSetInterface.php
@@ -20,7 +20,6 @@
 
 /**
  * Describes how a collection of datasource results should look like
- *
  */
 interface ResultSetInterface extends CollectionInterface, Countable, Serializable
 {

diff --git a/src/Error/FatalErrorException.php b/src/Error/FatalErrorException.php
@@ -16,7 +16,6 @@
 
 /**
  * Represents a fatal error
- *
  */
 class FatalErrorException extends Exception
 {

diff --git a/src/Error/PHP7ErrorException.php b/src/Error/PHP7ErrorException.php
@@ -18,7 +18,6 @@
  * Wraps a PHP 7 Error object inside a normal Exception
  * so it can be handled correctly by the rest of the
  * error handling system
- *
  */
 class PHP7ErrorException extends Exception
 {

diff --git a/src/Event/Event.php b/src/Event/Event.php
@@ -18,7 +18,6 @@
  * Represents the transport class of events across the system. It receives a name, subject and an optional
  * payload. The name can be any string that uniquely identifies the event across the application, while the subject
  * represents the object that the event applies to.
- *
  */
 class Event
 {

diff --git a/src/Event/EventDispatcherTrait.php b/src/Event/EventDispatcherTrait.php
@@ -16,7 +16,6 @@
 
 /**
  * Implements Cake\Event\EventDispatcherInterface.
- *
  */
 trait EventDispatcherTrait
 {

diff --git a/src/Event/EventListenerInterface.php b/src/Event/EventListenerInterface.php
@@ -17,7 +17,6 @@
 /**
  * Objects implementing this interface should declare the `implementedEvents` function
  * to notify the event manager what methods should be called when an event is triggered.
- *
  */
 interface EventListenerInterface
 {

diff --git a/src/Filesystem/File.php b/src/Filesystem/File.php
@@ -18,7 +18,6 @@
 
 /**
  * Convenience class for reading, writing and appending to files.
- *
  */
 class File
 {

diff --git a/src/I18n/ChainMessagesLoader.php b/src/I18n/ChainMessagesLoader.php
@@ -20,7 +20,6 @@
 /**
  * Wraps multiple message loaders calling them one after another until
  * one of them returns a non-empty package.
- *
  */
 class ChainMessagesLoader
 {

diff --git a/src/I18n/Time.php b/src/I18n/Time.php
@@ -23,7 +23,6 @@
 /**
  * Extends the built-in DateTime class to provide handy methods and locale-aware
  * formatting helpers
- *
  */
 class Time extends MutableDateTime implements JsonSerializable
 {

diff --git a/src/Log/Engine/BaseLog.php b/src/Log/Engine/BaseLog.php
@@ -20,7 +20,6 @@
 
 /**
  * Base log engine class.
- *
  */
 abstract class BaseLog extends AbstractLogger
 {

diff --git a/src/Log/Engine/FileLog.php b/src/Log/Engine/FileLog.php
@@ -20,7 +20,6 @@
 /**
  * File Storage stream for Logging. Writes logs to different files
  * based on the level of log it is.
- *
  */
 class FileLog extends BaseLog
 {

diff --git a/src/Mailer/AbstractTransport.php b/src/Mailer/AbstractTransport.php
@@ -18,7 +18,6 @@
 
 /**
  * Abstract transport for sending email
- *
  */
 abstract class AbstractTransport
 {

diff --git a/src/Mailer/Exception/MissingMailerException.php b/src/Mailer/Exception/MissingMailerException.php
@@ -18,7 +18,6 @@
 
 /**
  * Used when a mailer cannot be found.
- *
  */
 class MissingMailerException extends Exception
 {

diff --git a/src/Mailer/Transport/DebugTransport.php b/src/Mailer/Transport/DebugTransport.php
@@ -22,7 +22,6 @@
 /**
  * Debug Transport class, useful for emulate the email sending process and inspect the resulted
  * email message before actually send it during development
- *
  */
 class DebugTransport extends AbstractTransport
 {