chore: better phpdoc for cache items (#409)

googleapis · Aug 10, 2022 · deab935 · deab935
1 parent 45a22aa
commit deab935
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/src/Cache/Item.php b/src/Cache/Item.php
@@ -25,6 +25,10 @@
 
 /**
  * A cache item.
+ *
+ * This class will be used by MemoryCacheItemPool and SysVCacheItemPool
+ * on PHP 7.4 and below. It is compatible with psr/cache 1.0 and 2.0 (PSR-6).
+ * @see TypedItem for compatiblity with psr/cache 3.0.
  */
 final class Item implements CacheItemInterface
 {

diff --git a/src/Cache/TypedItem.php b/src/Cache/TypedItem.php
@@ -21,6 +21,10 @@
 
 /**
  * A cache item.
+ *
+ * This class will be used by MemoryCacheItemPool and SysVCacheItemPool
+ * on PHP 8.0 and above. It is compatible with psr/cache 3.0 (PSR-6).
+ * @see Item for compatiblity with previous versions of PHP.
  */
 final class TypedItem implements CacheItemInterface
 {