polishing apidocs

Author: StjepanovicSrdjan

cidre/src/commonMain/kotlin/at/asitplus/cidre/IpAddressAndPrefix.kt

@@ -47,8 +47,8 @@ sealed interface IpAddressAndPrefix<N : Number, S : CidrNumber<S>> {
 
     /**
      * Encodes this network into X.509 iPAddressName ByteArray (RFC 5280).
-     * IPv4: [4 bytes base address][4 bytes subnet mask]  (8 bytes)
-     * IPv6: [16 bytes base address][16 bytes subnet mask] (32 bytes)
+     * IPv4 byte layout: `AAAANNNN`, where `A` is an address octet and `N` is a netmask octet (8 bytes total)
+     * IPv6 byte layout:  `AAAAAAAAAAAAAAAANNNNNNNNNNNNNNNN`, where `A` is an address octet and `N` is a netmask octet(32 bytes total)
      */
     fun toX509Octets(): ByteArray = address.octets + netmask
 
@@ -57,8 +57,8 @@ sealed interface IpAddressAndPrefix<N : Number, S : CidrNumber<S>> {
         /**
          * Low-level helper used by [IpNetwork.fromX509Octets] and [IpInterface.fromX509Octets]
          * to extract base address and CIDR prefix
-         * IPv4: [4 bytes base address][4 bytes subnet mask]  (8 bytes)
-         * IPv6: [16 bytes base address][16 bytes subnet mask] (32 bytes)
+         * IPv4 byte layout: `AAAANNNN`, where `A` is an address octet and `N` is a netmask octet (8 bytes total)
+         * IPv6 byte layout:  `AAAAAAAAAAAAAAAANNNNNNNNNNNNNNNN`, where `A` is an address octet and `N` is a netmask octet(32 bytes total)
          */
         internal fun parseX509Octets(bytes: ByteArray): Pair<IpAddress<*, *>, Prefix> =
             when (bytes.size) {

cidre/src/commonMain/kotlin/at/asitplus/cidre/IpInterface.kt

@@ -45,8 +45,8 @@ constructor(override val prefix: Prefix, val network: IpNetwork<N, S>) :
 
         /**
          * Decodes an IpInterface from X.509 iPAddressName ByteArray (RFC 5280).
-         * IPv4: [4 bytes base address][4 bytes subnet mask]  (8 bytes)
-         * IPv6: [16 bytes base address][16 bytes subnet mask] (32 bytes)
+         * IPv4 byte layout: `AAAANNNN`, where `A` is an address octet and `N` is a netmask octet (8 bytes total)
+         * IPv6 byte layout:  `AAAAAAAAAAAAAAAANNNNNNNNNNNNNNNN`, where `A` is an address octet and `N` is a netmask octet(32 bytes total)
          */
         @Throws(IllegalArgumentException::class)
         fun fromX509Octets(bytes: ByteArray): IpInterface<*, *> {

cidre/src/commonMain/kotlin/at/asitplus/cidre/IpNetwork.kt

@@ -531,8 +531,8 @@ constructor(address: IpAddress<N, S>, override val prefix: Prefix, strict: Boole
 
         /**
          * Decodes an IpNetwork from X.509 iPAddressName ByteArray (RFC 5280).
-         * IPv4: [4 bytes base address][4 bytes subnet mask]  (8 bytes)
-         * IPv6: [16 bytes base address][16 bytes subnet mask] (32 bytes)
+         * IPv4 byte layout: `AAAANNNN`, where `A` is an address octet and `N` is a netmask octet (8 bytes total)
+         * IPv6 byte layout:  `AAAAAAAAAAAAAAAANNNNNNNNNNNNNNNN`, where `A` is an address octet and `N` is a netmask octet(32 bytes total)
          */
         fun fromX509Octets(bytes: ByteArray): IpNetwork<*, *> {
             val (addr, prefix) = parseX509Octets(bytes)

local.properties

@@ -1 +1,8 @@
-sdk.dir=/Users/bpruenster/Library/Android/sdk
+## This file must *NOT* be checked into Version Control Systems,
+# as it contains information specific to your local configuration.
+#
+# Location of the SDK. This is only used by Gradle.
+# For customization when using a Version Control System, please read the
+# header note.
+#Tue Sep 23 11:14:58 CEST 2025
+sdk.dir=C\:\\Users\\srdjan.stjepanovic\\AppData\\Local\\Android\\Sdk