Add a haddock comment for MapField. (google#285)

avdv · Dec 15, 2018 · 93ed86d · 93ed86d
1 parent 9f7ba63
commit 93ed86d
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/Data/ProtoLens/Compiler/Definitions.hs b/src/Data/ProtoLens/Compiler/Definitions.hs
@@ -191,6 +191,9 @@ data FieldKind
         -- whether the field's FieldDescriptorProto of the field has
         -- options.map_entry set.
     | MapField MapEntryInfo
+       -- ^ A field containing a map of keys to values.
+       -- Serialized as a repeated field of an autogenerated "entry"
+       -- proto type, each instance of which contains a key-value pair.
 
 data FieldPacking
     = NotPackable  -- ^ Cannot be packed (e.g., strings or messages).