@@ -77,6 +77,8 @@ instance ToYaml Text where
7777instance ToYaml Int where
7878 toYaml i = YamlBuilder (EventScalar (S8.pack $ show i) IntTag PlainNoTag Nothing:)
7979
80+-- |
81+-- @since 0.11.0
8082maybeNamedMapping :: Maybe Text -> [(Text, YamlBuilder)] -> YamlBuilder
8183maybeNamedMapping anchor pairs = YamlBuilder $ \rest ->
8284 EventMappingStart NoTag AnyMapping (unpack <$> anchor) : foldr addPair (EventMappingEnd : rest) pairs
@@ -88,9 +90,13 @@ maybeNamedMapping anchor pairs = YamlBuilder $ \rest ->
8890mapping :: [(Text, YamlBuilder)] -> YamlBuilder
8991mapping = maybeNamedMapping Nothing
9092
93+-- |
94+-- @since 0.11.0
9195namedMapping :: Text -> [(Text, YamlBuilder)] -> YamlBuilder
9296namedMapping name = maybeNamedMapping $ Just name
9397
98+-- |
99+-- @since 0.11.0
94100maybeNamedArray :: Maybe Text -> [YamlBuilder] -> YamlBuilder
95101maybeNamedArray anchor bs =
96102 YamlBuilder $ (EventSequenceStart NoTag AnySequence (unpack <$> anchor):) . flip (foldr go) bs . (EventSequenceEnd:)
@@ -100,9 +106,13 @@ maybeNamedArray anchor bs =
100106array :: [YamlBuilder] -> YamlBuilder
101107array = maybeNamedArray Nothing
102108
109+-- |
110+-- @since 0.11.0
103111namedArray :: Text -> [YamlBuilder] -> YamlBuilder
104112namedArray name = maybeNamedArray $ Just name
105113
114+-- |
115+-- @since 0.11.0
106116maybeNamedString :: Maybe Text -> Text -> YamlBuilder
107117-- Empty strings need special handling to ensure they get quoted. This avoids:
108118-- https://github.com/snoyberg/yaml/issues/24
@@ -119,16 +129,22 @@ maybeNamedString anchor s =
119129string :: Text -> YamlBuilder
120130string = maybeNamedString Nothing
121131
132+-- |
133+-- @since 0.11.0
122134namedString :: Text -> Text -> YamlBuilder
123135namedString name = maybeNamedString $ Just name
124136
125137-- Use aeson's implementation which gets rid of annoying decimal points
138+-- |
139+-- @since 0.11.0
126140maybeNamedScientific :: Maybe Text -> Scientific -> YamlBuilder
127141maybeNamedScientific anchor n = YamlBuilder (EventScalar (TE.encodeUtf8 $ TL.toStrict $ toLazyText $ encodeToTextBuilder (Number n)) IntTag PlainNoTag (unpack <$> anchor) :)
128142
129143scientific :: Scientific -> YamlBuilder
130144scientific = maybeNamedScientific Nothing
131145
146+-- |
147+-- @since 0.11.0
132148namedScientific :: Text -> Scientific -> YamlBuilder
133149namedScientific name = maybeNamedScientific $ Just name
134150
@@ -136,6 +152,8 @@ namedScientific name = maybeNamedScientific $ Just name
136152number :: Scientific -> YamlBuilder
137153number = scientific
138154
155+-- |
156+-- @since 0.11.0
139157maybeNamedBool :: Maybe Text -> Bool -> YamlBuilder
140158maybeNamedBool anchor True = YamlBuilder (EventScalar "true" BoolTag PlainNoTag (unpack <$> anchor) :)
141159maybeNamedBool anchor False = YamlBuilder (EventScalar "false" BoolTag PlainNoTag (unpack <$> anchor) :)
@@ -143,18 +161,26 @@ maybeNamedBool anchor False = YamlBuilder (EventScalar "false" BoolTag PlainNoT
143161bool :: Bool -> YamlBuilder
144162bool = maybeNamedBool Nothing
145163
164+-- |
165+-- @since 0.11.0
146166namedBool :: Text -> Bool -> YamlBuilder
147167namedBool name = maybeNamedBool $ Just name
148168
169+-- |
170+-- @since 0.11.0
149171maybeNamedNull :: Maybe Text -> YamlBuilder
150172maybeNamedNull anchor = YamlBuilder (EventScalar "null" NullTag PlainNoTag (unpack <$> anchor) :)
151173
152174null :: YamlBuilder
153175null = maybeNamedNull Nothing
154176
177+-- |
178+-- @since 0.11.0
155179namedNull :: Text -> YamlBuilder
156180namedNull name = maybeNamedNull $ Just name
157181
182+-- |
183+-- @since 0.11.0
158184alias :: Text -> YamlBuilder
159185alias anchor = YamlBuilder (EventAlias (unpack anchor) :)
160186