Add description to codec interfaces

mongodb · Jul 7, 2023 · 8fa0518 · 8fa0518
1 parent cf08982
commit 8fa0518
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 0 deletions.
diff --git a/src/Codec/Codec.php b/src/Codec/Codec.php
@@ -3,6 +3,9 @@
 namespace MongoDB\Codec;
 
 /**
+ * The Codec interface allows decoding BSON data to native PHP types and back
+ * to BSON.
+ *
  * @psalm-template BSONType
  * @psalm-template NativeType
  * @template-extends Decoder<BSONType, NativeType>

diff --git a/src/Codec/DocumentCodec.php b/src/Codec/DocumentCodec.php
@@ -5,6 +5,9 @@
 use MongoDB\BSON\Document;
 
 /**
+ * The DocumentCodec interface allows decoding BSON document data to native PHP
+ * objects and back to BSON documents.
+ *
  * @psalm-template ObjectType of object
  * @template-extends Codec<Document, ObjectType>
  */

diff --git a/src/Codec/KnowsCodecLibrary.php b/src/Codec/KnowsCodecLibrary.php
@@ -2,6 +2,11 @@
 
 namespace MongoDB\Codec;
 
+/**
+ * This interface is used to indicate that a class is aware of the CodecLibrary
+ * it was added to. The library will be injected when the codec is added to the
+ * library. This allows codecs to recursively encode its nested values.
+ */
 interface KnowsCodecLibrary
 {
     public function attachLibrary(CodecLibrary $library): void;