Fix doc comments

Signed-off-by: Norio Nomura <[email protected]>

Author: norio-nomura

vmnet.go

@@ -18,7 +18,7 @@ import (
 )
 
 // The status code returning the result of vmnet operations.
-// see: https://developer.apple.com/documentation/vmnet/vmnet_return_t?language=objc
+//   - https://developer.apple.com/documentation/vmnet/vmnet_return_t?language=objc
 type VmnetReturn C.uint32_t
 
 const (
@@ -66,8 +66,8 @@ func (e VmnetReturn) Error() string {
 	}
 }
 
-// VmnetMode defines the mode of a vmnet network.
-// see: https://developer.apple.com/documentation/vmnet/operating_modes_t?language=objc
+// VmnetMode defines the mode of a [VmnetNetwork].
+//   - https://developer.apple.com/documentation/vmnet/operating_modes_t?language=objc
 type VmnetMode uint32
 
 const (
@@ -77,16 +77,15 @@ const (
 	BridgedMode VmnetMode = C.VMNET_BRIDGED_MODE
 )
 
-// VmnetNetworkConfiguration is configuration for a vmnet network.
-// see: https://developer.apple.com/documentation/vmnet/vmnet_network_configuration_create(_:_:)?language=objc
+// VmnetNetworkConfiguration is configuration for the [VmnetNetwork].
+//   - https://developer.apple.com/documentation/vmnet/vmnet_network_configuration_create(_:_:)?language=objc
 type VmnetNetworkConfiguration struct {
 	*pointer
 }
 
-// NewVmnetNetworkConfiguration creates a new VmnetNetworkConfiguration with mode.
-// This is only supported on macOS 26 and newer, error will
-// be returned on older versions.
-// BridgedMode is not supported by this function.
+// NewVmnetNetworkConfiguration creates a new [VmnetNetworkConfiguration] with [VmnetMode].
+// This is only supported on macOS 26 and newer, error will be returned on older versions.
+// [BridgedMode] is not supported by this function.
 func NewVmnetNetworkConfiguration(mode VmnetMode) (*VmnetNetworkConfiguration, error) {
 	if err := macOSAvailable(26); err != nil {
 		return nil, err
@@ -108,9 +107,9 @@ func NewVmnetNetworkConfiguration(mode VmnetMode) (*VmnetNetworkConfiguration, e
 	return config, nil
 }
 
-// SetExternalInterface sets the external interface of a vmnet network.
-// This is only available to networks of SharedMode.
-// see: https://developer.apple.com/documentation/vmnet/vmnet_network_configuration_set_external_interface(_:_:)?language=objc
+// SetExternalInterface sets the external interface of the [VmnetNetwork].
+// This is only available to networks of [SharedMode].
+//   - https://developer.apple.com/documentation/vmnet/vmnet_network_configuration_set_external_interface(_:_:)?language=objc
 func (c *VmnetNetworkConfiguration) SetExternalInterface(ifname string) error {
 	cIfname := C.CString(ifname)
 	defer C.free(unsafe.Pointer(cIfname))
@@ -125,40 +124,40 @@ func (c *VmnetNetworkConfiguration) SetExternalInterface(ifname string) error {
 	return nil
 }
 
-// DisableNat44 disables NAT44 on a network.
-// see: https://developer.apple.com/documentation/vmnet/vmnet_network_configuration_disable_nat44(_:)?language=objc
+// DisableNat44 disables NAT44 on the [VmnetNetwork].
+//   - https://developer.apple.com/documentation/vmnet/vmnet_network_configuration_disable_nat44(_:)?language=objc
 func (c *VmnetNetworkConfiguration) DisableNat44() {
 	C.VZVmnetNetworkConfiguration_disableNat44(objc.Ptr(c))
 }
 
-// DisableNat66 disables NAT66 on a network.
-// see: https://developer.apple.com/documentation/vmnet/vmnet_network_configuration_disable_nat66(_:)?language=objc
+// DisableNat66 disables NAT66 on the [VmnetNetwork].
+//   - https://developer.apple.com/documentation/vmnet/vmnet_network_configuration_disable_nat66(_:)?language=objc
 func (c *VmnetNetworkConfiguration) DisableNat66() {
 	C.VZVmnetNetworkConfiguration_disableNat66(objc.Ptr(c))
 }
 
-// DisableDhcp disables DHCP server on a network.
-// see: https://developer.apple.com/documentation/vmnet/vmnet_network_configuration_disable_dhcp(_:)?language=objc
+// DisableDhcp disables DHCP server on the [VmnetNetwork].
+//   - https://developer.apple.com/documentation/vmnet/vmnet_network_configuration_disable_dhcp(_:)?language=objc
 func (c *VmnetNetworkConfiguration) DisableDhcp() {
 	C.VZVmnetNetworkConfiguration_disableDhcp(objc.Ptr(c))
 }
 
-// DisableDnsProxy disables DNS proxy on a network.
-// see: https://developer.apple.com/documentation/vmnet/vmnet_network_configuration_disable_dns_proxy(_:)?language=objc
+// DisableDnsProxy disables DNS proxy on the [VmnetNetwork].
+//   - https://developer.apple.com/documentation/vmnet/vmnet_network_configuration_disable_dns_proxy(_:)?language=objc
 func (c *VmnetNetworkConfiguration) DisableDnsProxy() {
 	C.VZVmnetNetworkConfiguration_disableDnsProxy(objc.Ptr(c))
 }
 
-// DisableRouterAdvertisement disables router advertisement on a network.
-// see: https://developer.apple.com/documentation/vmnet/vmnet_network_configuration_disable_router_advertisement(_:)?language=objc
+// DisableRouterAdvertisement disables router advertisement on the [VmnetNetwork].
+//   - https://developer.apple.com/documentation/vmnet/vmnet_network_configuration_disable_router_advertisement(_:)?language=objc
 func (c *VmnetNetworkConfiguration) DisableRouterAdvertisement() {
 	C.VZVmnetNetworkConfiguration_disableRouterAdvertisement(objc.Ptr(c))
 }
 
-// SetIPv4Subnet configures the IPv4 address for a vmnet network.
+// SetIPv4Subnet configures the IPv4 address for the [VmnetNetwork].
 // Note that the first, second, and last addresses of the range are reserved.
 // The second address is reserved for the host, the first and last are not assignable to any node.
-// see: https://developer.apple.com/documentation/vmnet/vmnet_network_configuration_set_ipv4_subnet(_:_:_:)?language=objc
+//   - https://developer.apple.com/documentation/vmnet/vmnet_network_configuration_set_ipv4_subnet(_:_:_:)?language=objc
 func (c *VmnetNetworkConfiguration) SetIPv4Subnet(subnet netip.Prefix) error {
 	if !subnet.Addr().Is4() {
 		return fmt.Errorf("subnet is not ipv4")
@@ -187,8 +186,8 @@ func (c *VmnetNetworkConfiguration) SetIPv4Subnet(subnet netip.Prefix) error {
 	return nil
 }
 
-// SetIPv6Prefix configures the IPv6 prefix for a vmnet network.
-// see: https://developer.apple.com/documentation/vmnet/vmnet_network_configuration_set_ipv6_prefix(_:_:_:)?language=objc
+// SetIPv6Prefix configures the IPv6 prefix for the [VmnetNetwork].
+//   - https://developer.apple.com/documentation/vmnet/vmnet_network_configuration_set_ipv6_prefix(_:_:_:)?language=objc
 func (c *VmnetNetworkConfiguration) SetIPv6Prefix(prefix netip.Prefix) error {
 	if !prefix.Addr().Is6() {
 		return fmt.Errorf("prefix is not ipv6")
@@ -209,7 +208,7 @@ func (c *VmnetNetworkConfiguration) SetIPv6Prefix(prefix netip.Prefix) error {
 	return nil
 }
 
-// AddPortForwardingRule configures a port forwarding rule for the vmnet network.
+// AddPortForwardingRule configures a port forwarding rule for the [VmnetNetwork].
 // These rules will not be able to be removed or queried until network has been started.
 // To do that, use `vmnet_interface_remove_ip_forwarding_rule` or
 // `vmnet_interface_get_ip_port_forwarding_rules` C API directly.
@@ -220,7 +219,7 @@ func (c *VmnetNetworkConfiguration) SetIPv6Prefix(prefix netip.Prefix) error {
 // internalPort is the TCP or UDP port that forwarded traffic should be redirected to.
 // externalPort is the TCP or UDP port on the outside network that should be redirected from.
 // internalAddress is the IPv4 or IPv6 address of the machine on the internal network that should receive the forwarded traffic.
-// see: https://developer.apple.com/documentation/vmnet/vmnet_network_configuration_add_port_forwarding_rule(_:_:_:_:_:_:)?language=objc
+//   - https://developer.apple.com/documentation/vmnet/vmnet_network_configuration_add_port_forwarding_rule(_:_:_:_:_:_:)?language=objc
 func (c *VmnetNetworkConfiguration) AddPortForwardingRule(protocol uint8, addressFamily uint8, internalPort uint16, externalPort uint16, internalAddress netip.Addr) error {
 	var address unsafe.Pointer
 	switch addressFamily {
@@ -257,10 +256,10 @@ func (c *VmnetNetworkConfiguration) AddPortForwardingRule(protocol uint8, addres
 	return nil
 }
 
-// AddDhcpReservation configures a new DHCP reservation for the vmnet network.
+// AddDhcpReservation configures a new DHCP reservation for the [VmnetNetwork].
 // client is the MAC address for which the DHCP address is reserved.
 // reservation is the DHCP IPv4 address to be reserved.
-// see: https://developer.apple.com/documentation/vmnet/vmnet_network_configuration_add_dhcp_reservation(_:_:_:)?language=objc
+//   - https://developer.apple.com/documentation/vmnet/vmnet_network_configuration_add_dhcp_reservation(_:_:_:)?language=objc
 func (c *VmnetNetworkConfiguration) AddDhcpReservation(client *MACAddress, reservation netip.Addr) error {
 	if !reservation.Is4() {
 		return fmt.Errorf("reservation is not ipv4")
@@ -282,8 +281,8 @@ func (c *VmnetNetworkConfiguration) AddDhcpReservation(client *MACAddress, reser
 	return nil
 }
 
-// SetMtu configures the maximum transmission unit (MTU) for the vmnet network.
-// see: https://developer.apple.com/documentation/vmnet/vmnet_network_configuration_set_mtu(_:_:)?language=objc
+// SetMtu configures the maximum transmission unit (MTU) for the [VmnetNetwork].
+//   - https://developer.apple.com/documentation/vmnet/vmnet_network_configuration_set_mtu(_:_:)?language=objc
 func (c *VmnetNetworkConfiguration) SetMtu(mtu uint32) error {
 	status := C.VZVmnetNetworkConfiguration_setMtu(
 		objc.Ptr(c),
@@ -295,15 +294,14 @@ func (c *VmnetNetworkConfiguration) SetMtu(mtu uint32) error {
 	return nil
 }
 
-// VmnetNetwork represents a vmnet network.
-// see: https://developer.apple.com/documentation/vmnet/vmnet_network_create(_:_:)?language=objc
+// VmnetNetwork represents a [VmnetNetwork].
+//   - https://developer.apple.com/documentation/vmnet/vmnet_network_create(_:_:)?language=objc
 type VmnetNetwork struct {
 	*pointer
 }
 
-// NewVmnetNetwork creates a new VmnetNetwork with config.
-// This is only supported on macOS 26 and newer, error will
-// be returned on older versions.
+// NewVmnetNetwork creates a new [VmnetNetwork] with [VmnetNetworkConfiguration].
+// This is only supported on macOS 26 and newer, error will be returned on older versions.
 func NewVmnetNetwork(config *VmnetNetworkConfiguration) (*VmnetNetwork, error) {
 	if err := macOSAvailable(26); err != nil {
 		return nil, err
@@ -326,10 +324,9 @@ func NewVmnetNetwork(config *VmnetNetworkConfiguration) (*VmnetNetwork, error) {
 	return network, nil
 }
 
-// NewVmnetNetworkWithSerialization creates a new VmnetNetwork from a serialized representation.
-// This is only supported on macOS 26 and newer, error will
-// be returned on older versions.
-// see: https://developer.apple.com/documentation/vmnet/vmnet_network_create_with_serialization(_:_:)?language=objc
+// NewVmnetNetworkWithSerialization creates a new [VmnetNetwork] from a serialized representation.
+// This is only supported on macOS 26 and newer, error will be returned on older versions.
+//   - https://developer.apple.com/documentation/vmnet/vmnet_network_create_with_serialization(_:_:)?language=objc
 func NewVmnetNetworkWithSerialization(serialization unsafe.Pointer) (*VmnetNetwork, error) {
 	if err := macOSAvailable(26); err != nil {
 		return nil, err
@@ -352,7 +349,8 @@ func NewVmnetNetworkWithSerialization(serialization unsafe.Pointer) (*VmnetNetwo
 	return network, nil
 }
 
-// CopySerialization returns a pointer to a serialized representation of the vmnet network.
+// CopySerialization returns a serialized copy of [VmnetNetwork] in xpc_object_t as [unsafe.Pointer].
+//   - https://developer.apple.com/documentation/vmnet/vmnet_network_copy_serialization(_:_:)?language=objc
 func (n *VmnetNetwork) CopySerialization() (unsafe.Pointer, error) {
 	var status VmnetReturn
 	ptr := C.VZVmnetNetwork_copySerialization(
@@ -365,7 +363,8 @@ func (n *VmnetNetwork) CopySerialization() (unsafe.Pointer, error) {
 	return ptr, nil
 }
 
-// IPv6Prefix returns the IPv6 prefix of the network.
+// IPv6Prefix returns the IPv6 prefix of the [VmnetNetwork].
+//   - https://developer.apple.com/documentation/vmnet/vmnet_network_get_ipv6_prefix(_:_:_:)?language=objc
 func (n *VmnetNetwork) IPv6Prefix() (netip.Prefix, error) {
 	var prefix C.struct_in6_addr
 	var prefixLen C.uint8_t
@@ -386,7 +385,8 @@ func in6AddrToNetipAddr(a C.struct_in6_addr) netip.Addr {
 	return netip.AddrFrom16(*p)
 }
 
-// IPv4Subnet returns the IPv4 subnet of the network.
+// IPv4Subnet returns the IPv4 subnet of the [VmnetNetwork].
+//   - https://developer.apple.com/documentation/vmnet/vmnet_network_get_ipv4_subnet(_:_:_:)?language=objc
 func (n *VmnetNetwork) IPv4Subnet() (subnet netip.Prefix, err error) {
 	var cSubnet C.struct_in_addr
 	var cMask C.struct_in_addr