add more haddock comments

persistent/Database/Persist/EntityDef.hs

@@ -91,6 +91,10 @@ getEntityDBName = entityDB
 getEntityExtra :: EntityDef -> Map Text [[Text]]
 getEntityExtra = entityExtra
 
+-- | Get the (optional) schema for an entity. Specified with the syntax
+-- `schema=foo` on the Persistent model.
+--
+-- @since 2.14.7
 getEntitySchema :: EntityDef -> Maybe SchemaNameDB
 getEntitySchema = entitySchema
 
@@ -200,6 +204,9 @@ getEntityKeyFields = entityKeyFields
 setEntityFields :: [FieldDef] -> EntityDef -> EntityDef
 setEntityFields fd ed = ed { entityFields = fd }
 
+-- | Update the entity schema.
+--
+-- @since 2.14.7
 setEntitySchema :: Maybe SchemaNameDB -> EntityDef -> EntityDef
 setEntitySchema sn ed = ed { entitySchema = sn }
 

persistent/Database/Persist/Names.hs

@@ -71,6 +71,10 @@ instance DatabaseName ConstraintNameDB where
 newtype ConstraintNameHS = ConstraintNameHS { unConstraintNameHS :: Text }
   deriving (Show, Eq, Read, Ord, Lift)
 
+-- | The name of a database schema. Different backends vary in their
+-- interpretation of this concept.
+--
+-- @since 2.14.7
 newtype SchemaNameDB = SchemaNameDB { unSchemaNameDB :: Text }
   deriving (Show, Eq, Read, Ord, Lift)
 

persistent/Database/Persist/Quasi/Internal.hs

@@ -311,6 +311,7 @@ data ParsedEntityDef = ParsedEntityDef
     { parsedEntityDefComments :: [Text]
     , parsedEntityDefEntityName :: EntityNameHS
     , parsedEntityDefSchemaName :: Maybe SchemaNameDB
+      -- ^ @since 2.14.7
     , parsedEntityDefIsSum :: Bool
     , parsedEntityDefEntityAttributes :: [Attr]
     , parsedEntityDefFieldAttributes :: [[Token]]

persistent/Database/Persist/Types/Base.hs

@@ -153,10 +153,12 @@ data EntityDef = EntityDef
     -- ^ Whether or not this entity represents a sum type in the database.
     , entityComments :: !(Maybe Text)
     -- ^ Optional comments on the entity.
+    --
+    -- @since 2.10.0
     , entitySchema :: !(Maybe SchemaNameDB)
     -- ^ The schema the entity belongs to.
     --
-    -- @since 2.10.0
+    -- @since 2.14.7
     }
     deriving (Show, Eq, Read, Ord, Lift)