add example

Comcast · Oct 18, 2023 · 98d87fa · 98d87fa
1 parent fe556b2
commit 98d87fa
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/shared/src/main/scala/com/comcast/ip4s/Cidr.scala b/shared/src/main/scala/com/comcast/ip4s/Cidr.scala
@@ -37,6 +37,11 @@ sealed class Cidr[+A <: IpAddress] protected (val address: A, val prefixBits: In
     * is (and prints as) a spec-valid cidr range, with no bits outside the routing mask set.
     *
     * @return a normalized cidr range
+    *
+    * @example {{{
+    * scala> Cidr(ipv4"10.11.12.13", 8).normalized
+    * res0: Cidr.Strict[Ipv4Address] = 10.0.0.0/8
+    * }}}
     */
   def normalized: Strict[A] = Cidr.Strict(this)