[#15956] - correcting docblocks

niden · niden · commit 7c023b9ee146 · 2022-11-01T15:55:26.000-04:00
diff --git a/phalcon/Acl/Adapter/AdapterInterface.zep b/phalcon/Acl/Adapter/AdapterInterface.zep
@@ -33,7 +33,7 @@ interface AdapterInterface
      * Adds a component to the ACL list
      *
      * Access names can be a particular action, by example
-     * search, update, delete, etc or a list of them
+     * search, update, delete, etc. or a list of them
      */
     public function addComponent(componentValue, accessList) -> bool;
 
@@ -53,7 +53,7 @@ interface AdapterInterface
     public function deny(string roleName, string componentName, access, func = null) -> void;
 
     /**
-     * Removes an access from a component
+     * Removes access from a component
      */
     public function dropComponentAccess(string componentName, accessList) -> void;
 
diff --git a/phalcon/Acl/Adapter/Memory.zep b/phalcon/Acl/Adapter/Memory.zep
@@ -100,7 +100,7 @@ class Memory extends AbstractAdapter
     protected accessList;
 
     /**
-     * Returns latest function used to acquire access
+     * Returns the latest function used to acquire access
      *
      * @var mixed
      */
@@ -114,7 +114,7 @@ class Memory extends AbstractAdapter
     protected activeFunctionCustomArgumentsCount = 0;
 
     /**
-     * Returns latest key used to acquire access
+     * Returns the latest key used to acquire access
      *
      * @var string|null
      */
@@ -142,7 +142,7 @@ class Memory extends AbstractAdapter
     protected func;
 
     /**
-     * Default action for no arguments is allow
+     * Default action for no arguments is `allow`
      *
      * @var mixed
      */
@@ -175,11 +175,11 @@ class Memory extends AbstractAdapter
      * Adds a component to the ACL list
      *
      * Access names can be a particular action, by example
-     * search, update, delete, etc or a list of them
+     * search, update, delete, etc. or a list of them
      *
      * Example:
      * ```php
-     * // Add a component to the the list allowing access to an action
+     * // Add a component to the list allowing access to an action
      * $acl->addComponent(
      *     new Phalcon\Acl\Component("customers"),
      *     "search"
@@ -482,7 +482,7 @@ class Memory extends AbstractAdapter
     }
 
     /**
-     * Removes an access from a component
+     * Removes access from a component
      */
     public function dropComponentAccess(string componentName, var accessList) -> void
     {
@@ -508,7 +508,7 @@ class Memory extends AbstractAdapter
      }
 
     /**
-     * Returns latest function used to acquire access
+     * Returns the latest function used to acquire access
      *
      * @return mixed
      */
@@ -526,7 +526,7 @@ class Memory extends AbstractAdapter
     }
 
     /**
-     * Returns latest key used to acquire access
+     * Returns the latest key used to acquire access
      */
     public function getActiveKey() -> string | null
     {
diff --git a/phalcon/Assets/Asset.zep b/phalcon/Assets/Asset.zep
@@ -16,18 +16,6 @@ namespace Phalcon\Assets;
  *```php
  * $asset = new \Phalcon\Assets\Asset("js", "js/jquery.js");
  *```
- *
- * @property array       $attributes
- * @property bool        $isAutoVersion
- * @property bool        $filter
- * @property bool        $isLocal
- * @property string      $path
- * @property string      $sourcePath
- * @property string      $targetPath
- * @property string      $targetUri
- * @property string      $type
- * @property string|null $version
- *
  */
 class Asset implements AssetInterface
 {
diff --git a/phalcon/Assets/Collection.zep b/phalcon/Assets/Collection.zep
@@ -16,20 +16,6 @@ use IteratorAggregate;
 
 /**
  * Collection of asset objects
- *
- * @property array  $assets
- * @property array  $attributes
- * @property bool   $autoVersion
- * @property array  $codes
- * @property array  $filters
- * @property bool   $join
- * @property bool   $isLocal
- * @property string $prefix
- * @property string $sourcePath
- * @property bool   $targetIsLocal
- * @property string $targetPath
- * @property string $targetUri
- * @property string $version
  */
 class Collection implements Countable, IteratorAggregate
 {
diff --git a/phalcon/Assets/Filters/CssMin.zep b/phalcon/Assets/Filters/CssMin.zep
@@ -20,7 +20,9 @@ class Cssmin implements FilterInterface
 {
     /**
      * Filters the content using CSSMIN
-     * NOTE: This functionality is not currently available
+     *
+     * > NOTE: This functionality is not currently available
+     * {: .alert .alert-info }
      */
     public function filter(string! content) -> string
     {
diff --git a/phalcon/Assets/Filters/JsMin.zep b/phalcon/Assets/Filters/JsMin.zep
@@ -21,7 +21,9 @@ class Jsmin implements FilterInterface
 {
     /**
      * Filters the content using JSMIN
-     * NOTE: This functionality is not currently available
+     *
+     * > NOTE: This functionality is not currently available
+     * {: .alert .alert-info }
      */
     public function filter(string! content) -> string
     {
diff --git a/phalcon/Assets/Manager.zep b/phalcon/Assets/Manager.zep
@@ -22,11 +22,6 @@ use Phalcon\Html\TagFactory;
 
 /**
  * Manages collections of CSS/JavaScript assets
- *
- * @property array      $collections
- * @property bool       $implicitOutput
- * @property array      $options
- * @property TagFactory $tagFactory
  */
 class Manager extends AbstractInjectionAware
 {
diff --git a/phalcon/Autoload/Loader.zep b/phalcon/Autoload/Loader.zep
@@ -16,18 +16,6 @@ use Phalcon\Events\AbstractEventsAware;
  * The Phalcon Autoloader provides an easy way to automatically load classes
  * (namespaced or not) as well as files. It also features extension loading,
  * allowing the user to autoload files with different extensions than .php.
- *
- * @property string|null          $checkedPath
- * @property array                $classes
- * @property array                $debug
- * @property array                $directories
- * @property array                $extensions
- * @property string|callable|null $fileCheckingCallback
- * @property array                $files
- * @property string|null          $foundPath
- * @property bool                 $isDebug
- * @property bool                 $isRegistered
- * @property array                $namespaces
  */
 class Loader extends AbstractEventsAware
 {
diff --git a/phalcon/Cache/AbstractCache.zep b/phalcon/Cache/AbstractCache.zep
@@ -17,9 +17,6 @@ use Traversable;
 
 /**
  * This component offers caching capabilities for your application.
- * Phalcon\Cache implements PSR-16.
- *
- * @property AdapterInterface $adapter
  */
 abstract class AbstractCache implements CacheInterface
 {
diff --git a/phalcon/Cache/AdapterFactory.zep b/phalcon/Cache/AdapterFactory.zep
@@ -17,8 +17,6 @@ use Phalcon\Storage\SerializerFactory;
 
 /**
  * Factory to create Cache adapters
- *
- * @property SerializerFactory $serializerFactory
  */
 class AdapterFactory extends AbstractFactory
 {
diff --git a/phalcon/Cache/Cache.zep b/phalcon/Cache/Cache.zep
@@ -16,9 +16,6 @@ use Phalcon\Cache\Exception\InvalidArgumentException;
 
 /**
  * This component offers caching capabilities for your application.
- * Phalcon\Cache implements PSR-16.
- *
- * @property AdapterInterface $adapter
  */
 class Cache extends AbstractCache
 {
diff --git a/phalcon/Cache/CacheFactory.zep b/phalcon/Cache/CacheFactory.zep
@@ -18,8 +18,6 @@ use Phalcon\Factory\AbstractConfigFactory;
 
 /**
  * Creates a new Cache class
- *
- * @property AdapterFactory $adapterFactory;
  */
 class CacheFactory extends AbstractConfigFactory
 {
diff --git a/phalcon/Config/Config.zep b/phalcon/Config/Config.zep
@@ -36,8 +36,6 @@ use Phalcon\Support\Collection;
  *     ]
  * );
  *```
- *
- * @property string $pathDelimiter
  */
 class Config extends Collection implements ConfigInterface
 {
diff --git a/phalcon/DataMapper/Pdo/Connection.zep b/phalcon/DataMapper/Pdo/Connection.zep
@@ -22,10 +22,6 @@ use Phalcon\DataMapper\Pdo\Profiler\ProfilerInterface;
 /**
  * Provides array quoting, profiling, a new `perform()` method, new `fetch*()`
  * methods
- *
- * @property array             $arguments
- * @property PDO               $pdo
- * @property ProfilerInterface $profiler
  */
 class Connection extends AbstractConnection
 {
diff --git a/phalcon/DataMapper/Pdo/Connection/AbstractConnection.zep b/phalcon/DataMapper/Pdo/Connection/AbstractConnection.zep
@@ -22,9 +22,6 @@ use Phalcon\DataMapper\Pdo\Profiler\ProfilerInterface;
 /**
  * Provides array quoting, profiling, a new `perform()` method, new `fetch*()`
  * methods
- *
- * @property PDO               $pdo
- * @property ProfilerInterface $profiler
  */
 abstract class AbstractConnection implements ConnectionInterface
 {
diff --git a/phalcon/DataMapper/Pdo/Connection/ConnectionInterface.zep b/phalcon/DataMapper/Pdo/Connection/ConnectionInterface.zep
@@ -22,11 +22,6 @@ use Phalcon\DataMapper\Pdo\Profiler\ProfilerInterface;
 /**
  * Provides array quoting, profiling, a new `perform()` method, new `fetch*()`
  * methods
- *
- * @property array             $args
- * @property PDO               $pdo
- * @property ProfilerInterface $profiler
- * @property array             $quote
  */
 interface ConnectionInterface extends PdoInterface
 {
diff --git a/phalcon/DataMapper/Pdo/ConnectionLocator.zep b/phalcon/DataMapper/Pdo/ConnectionLocator.zep
@@ -20,10 +20,6 @@ use Phalcon\DataMapper\Pdo\Exception\ConnectionNotFound;
 
 /**
  * Manages Connection instances for default, read, and write connections.
- *
- * @property callable $master
- * @property array    $read
- * @property array    $write
  */
 class ConnectionLocator implements ConnectionLocatorInterface
 {
diff --git a/phalcon/DataMapper/Pdo/Profiler/MemoryLogger.zep b/phalcon/DataMapper/Pdo/Profiler/MemoryLogger.zep
@@ -22,8 +22,6 @@ use Phalcon\Logger\LoggerInterface;
 
 /**
  * A memory-based logger.
- *
- * @property array $messages
  */
 class MemoryLogger implements LoggerInterface
 {
diff --git a/phalcon/DataMapper/Pdo/Profiler/Profiler.zep b/phalcon/DataMapper/Pdo/Profiler/Profiler.zep
@@ -22,12 +22,6 @@ use Phalcon\Logger\LoggerInterface;
 
 /**
  * Sends query profiles to a logger.
- *
- * @property bool            $active
- * @property array           $context
- * @property string          $logFormat
- * @property string          $logLevel
- * @property LoggerInterface $logger
  */
 class Profiler implements ProfilerInterface
 {
diff --git a/phalcon/DataMapper/Query/AbstractQuery.zep b/phalcon/DataMapper/Query/AbstractQuery.zep
@@ -19,10 +19,6 @@ use Phalcon\DataMapper\Pdo\Connection;
 
 /**
  * Class AbstractQuery
- *
- * @property Bind       $bind
- * @property Connection $connection
- * @property array      $store
  */
 abstract class AbstractQuery
 {
diff --git a/phalcon/DataMapper/Query/Bind.zep b/phalcon/DataMapper/Query/Bind.zep
@@ -17,9 +17,6 @@ namespace Phalcon\DataMapper\Query;
 
 /**
  * Class Bind
- *
- * @property int   $inlineCount
- * @property array $store
  */
 class Bind
 {
diff --git a/phalcon/DataMapper/Query/Delete.zep b/phalcon/DataMapper/Query/Delete.zep
@@ -17,6 +17,9 @@ namespace Phalcon\DataMapper\Query;
 
 use Phalcon\DataMapper\Pdo\Connection;
 
+/**
+ * Delete Query
+ */
 class Delete extends AbstractConditions
 {
     /**
diff --git a/phalcon/DataMapper/Query/Insert.zep b/phalcon/DataMapper/Query/Insert.zep
@@ -18,7 +18,7 @@ namespace Phalcon\DataMapper\Query;
 use Phalcon\DataMapper\Pdo\Connection;
 
 /**
- * Class Insert
+ * Insert Query
  */
 class Insert extends AbstractQuery
 {
diff --git a/phalcon/DataMapper/Query/QueryFactory.zep b/phalcon/DataMapper/Query/QueryFactory.zep
@@ -18,9 +18,7 @@ namespace Phalcon\DataMapper\Query;
 use Phalcon\DataMapper\Pdo\Connection;
 
 /**
- * Class QueryFactory
- *
- * @property string $class
+ * QueryFactory
  */
 class QueryFactory
 {
diff --git a/phalcon/DataMapper/Query/Select.zep b/phalcon/DataMapper/Query/Select.zep
@@ -18,21 +18,7 @@ namespace Phalcon\DataMapper\Query;
 use BadMethodCallException;
 
 /**
- * Class Select
- *
- * @property string $asAlias
- * @property bool   $forUpdate
- *
- * @method int    fetchAffected()
- * @method array  fetchAll()
- * @method array  fetchAssoc()
- * @method array  fetchColumn(int $column = 0)
- * @method array  fetchGroup(int $flags = PDO::FETCH_ASSOC)
- * @method object fetchObject(string $class = 'stdClass', array $arguments = [])
- * @method array  fetchObjects(string $class = 'stdClass', array $arguments = [])
- * @method array  fetchOne()
- * @method array  fetchPairs()
- * @method mixed  fetchValue()
+ * Select Query
  */
 class Select extends AbstractConditions
 {
diff --git a/phalcon/DataMapper/Query/Update.zep b/phalcon/DataMapper/Query/Update.zep
@@ -18,7 +18,7 @@ namespace Phalcon\DataMapper\Query;
 use Phalcon\DataMapper\Pdo\Connection;
 
 /**
- * Class Update
+ * Update Query
  */
 class Update extends AbstractConditions
 {
diff --git a/phalcon/Di/InitializationAwareInterface.zep b/phalcon/Di/InitializationAwareInterface.zep
@@ -10,6 +10,9 @@
 
 namespace Phalcon\Di;
 
+/**
+ * Interface for components that have `initialize()`
+ */
 interface InitializationAwareInterface
 {
     public function initialize() -> void;
diff --git a/phalcon/Encryption/Security/JWT/Builder.zep b/phalcon/Encryption/Security/JWT/Builder.zep
diff --git a/phalcon/Encryption/Security/JWT/Token/AbstractItem.zep b/phalcon/Encryption/Security/JWT/Token/AbstractItem.zep
diff --git a/phalcon/Encryption/Security/JWT/Token/Token.zep b/phalcon/Encryption/Security/JWT/Token/Token.zep
diff --git a/phalcon/Encryption/Security/JWT/Validator.zep b/phalcon/Encryption/Security/JWT/Validator.zep
diff --git a/phalcon/Events/AbstractEventsAware.zep b/phalcon/Events/AbstractEventsAware.zep

Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,7 @@ class Memory extends AbstractAdapter`
`100`	`100`	`protected accessList;`
`101`	`101`
`102`	`102`	`/**`
`103`		`- * Returns latest function used to acquire access`
	`103`	`+ * Returns the latest function used to acquire access`
`104`	`104`	`*`
`105`	`105`	`* @var mixed`
`106`	`106`	`*/`
`@@ -114,7 +114,7 @@ class Memory extends AbstractAdapter`
`114`	`114`	`protected activeFunctionCustomArgumentsCount = 0;`
`115`	`115`
`116`	`116`	`/**`
`117`		`- * Returns latest key used to acquire access`
	`117`	`+ * Returns the latest key used to acquire access`
`118`	`118`	`*`
`119`	`119`	`* @var string\|null`
`120`	`120`	`*/`
`@@ -142,7 +142,7 @@ class Memory extends AbstractAdapter`
`142`	`142`	`protected func;`
`143`	`143`
`144`	`144`	`/**`
`145`		`- * Default action for no arguments is allow`
	`145`	+ * Default action for no arguments is `allow`
`146`	`146`	`*`
`147`	`147`	`* @var mixed`
`148`	`148`	`*/`
`@@ -175,11 +175,11 @@ class Memory extends AbstractAdapter`
`175`	`175`	`* Adds a component to the ACL list`
`176`	`176`	`*`
`177`	`177`	`* Access names can be a particular action, by example`
`178`		`- * search, update, delete, etc or a list of them`
	`178`	`+ * search, update, delete, etc. or a list of them`
`179`	`179`	`*`
`180`	`180`	`* Example:`
`181`	`181`	* ```php
`182`		`- * // Add a component to the the list allowing access to an action`
	`182`	`+ * // Add a component to the list allowing access to an action`
`183`	`183`	`* $acl->addComponent(`
`184`	`184`	`* new Phalcon\Acl\Component("customers"),`
`185`	`185`	`* "search"`
`@@ -482,7 +482,7 @@ class Memory extends AbstractAdapter`
`482`	`482`	`}`
`483`	`483`
`484`	`484`	`/**`
`485`		`- * Removes an access from a component`
	`485`	`+ * Removes access from a component`
`486`	`486`	`*/`
`487`	`487`	`public function dropComponentAccess(string componentName, var accessList) -> void`
`488`	`488`	`{`
`@@ -508,7 +508,7 @@ class Memory extends AbstractAdapter`
`508`	`508`	`}`
`509`	`509`
`510`	`510`	`/**`
`511`		`- * Returns latest function used to acquire access`
	`511`	`+ * Returns the latest function used to acquire access`
`512`	`512`	`*`
`513`	`513`	`* @return mixed`
`514`	`514`	`*/`
`@@ -526,7 +526,7 @@ class Memory extends AbstractAdapter`
`526`	`526`	`}`
`527`	`527`
`528`	`528`	`/**`
`529`		`- * Returns latest key used to acquire access`
	`529`	`+ * Returns the latest key used to acquire access`
`530`	`530`	`*/`
`531`	`531`	`public function getActiveKey() -> string \| null`
`532`	`532`	`{`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,9 @@ class Cssmin implements FilterInterface`
`20`	`20`	`{`
`21`	`21`	`/**`
`22`	`22`	`* Filters the content using CSSMIN`
`23`		`- * NOTE: This functionality is not currently available`
	`23`	`+ *`
	`24`	`+ * > NOTE: This functionality is not currently available`
	`25`	`+ * {: .alert .alert-info }`
`24`	`26`	`*/`
`25`	`27`	`public function filter(string! content) -> string`
`26`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,9 @@ class Jsmin implements FilterInterface`
`21`	`21`	`{`
`22`	`22`	`/**`
`23`	`23`	`* Filters the content using JSMIN`
`24`		`- * NOTE: This functionality is not currently available`
	`24`	`+ *`
	`25`	`+ * > NOTE: This functionality is not currently available`
	`26`	`+ * {: .alert .alert-info }`
`25`	`27`	`*/`
`26`	`28`	`public function filter(string! content) -> string`
`27`	`29`	`{`
Original file line number	Diff line number	Diff line change
`@@ -17,9 +17,6 @@ use Traversable;`
`17`	`17`
`18`	`18`	`/**`
`19`	`19`	`* This component offers caching capabilities for your application.`
`20`		`- * Phalcon\Cache implements PSR-16.`
`21`		`- *`
`22`		`- * @property AdapterInterface $adapter`
`23`	`20`	`*/`
`24`	`21`	`abstract class AbstractCache implements CacheInterface`
`25`	`22`	`{`
Original file line number	Diff line number	Diff line change
`@@ -17,8 +17,6 @@ use Phalcon\Storage\SerializerFactory;`
`17`	`17`
`18`	`18`	`/**`
`19`	`19`	`* Factory to create Cache adapters`
`20`		`- *`
`21`		`- * @property SerializerFactory $serializerFactory`
`22`	`20`	`*/`
`23`	`21`	`class AdapterFactory extends AbstractFactory`
`24`	`22`	`{`