From 3c79ef183573c2a3f031a209fa0ca9843ff76110 Mon Sep 17 00:00:00 2001
From: Determinant <tederminant@gmail.com>
Date: Mon, 17 Jun 2019 14:20:03 -0400
Subject: add doc to netaddr.go

---
 netaddr.go | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/netaddr.go b/netaddr.go
index 4bd7ebb..09d9c8b 100644
--- a/netaddr.go
+++ b/netaddr.go
@@ -5,10 +5,17 @@ package salticidae
 import "C"
 import "runtime"
 
+// The C pointer type for a NetAddr object
 type CNetAddr = *C.netaddr_t
 type netAddr struct { inner CNetAddr }
+// Network address object.
 type NetAddr = *netAddr
 
+// Convert an existing C pointer into a go object. Notice that when the go
+// object does *not* own the resource of the C pointer, so it is only valid to
+// the extent in which the given C pointer is valid. The C memory will not be
+// deallocated when the go object is finalized by GC. This applies to all other
+// "FromC" functions.
 func NetAddrFromC(ptr CNetAddr) NetAddr {
     return &netAddr{ inner: ptr }
 }
@@ -17,8 +24,10 @@ type netAddrArray struct {
     inner *C.netaddr_array_t
 }
 
+// An array of network address.
 type NetAddrArray = *netAddrArray
 
+// Create NetAddr from a TCP socket format string (e.g. 127.0.0.1:8888).
 func NewAddrFromIPPortString(addr string) (res NetAddr) {
     c_str := C.CString(addr)
     res = &netAddr{ inner: C.netaddr_new_from_sipport(c_str) }
@@ -27,6 +36,7 @@ func NewAddrFromIPPortString(addr string) (res NetAddr) {
     return
 }
 
+// Convert a Go slice of net addresses to NetAddrArray.
 func NewAddrArrayFromAddrs(arr []NetAddr) (res NetAddrArray) {
     size := len(arr)
     if size > 0 {
@@ -43,14 +53,21 @@ func NewAddrArrayFromAddrs(arr []NetAddr) (res NetAddrArray) {
 
 func (self NetAddr) free() { C.netaddr_free(self.inner) }
 
+// Check if two addresses are the same.
 func (self NetAddr) IsEq(other NetAddr) bool { return bool(C.netaddr_is_eq(self.inner, other.inner)) }
 
 func (self NetAddr) IsNull() bool { return bool(C.netaddr_is_null(self.inner)) }
 
+// Get the 32-bit IP representation.
 func (self NetAddr) GetIP() uint32 { return uint32(C.netaddr_get_ip(self.inner)) }
 
+// Get the 16-bit port number (in UNIX network byte order, so need to apply
+// ntohs(), for example, to convert the returned integer to the local endianness).
 func (self NetAddr) GetPort() uint16 { return uint16(C.netaddr_get_port(self.inner)) }
 
+// Make a copy of the object. This is required if you want to keep the NetAddr
+// returned (or passed as a callback parameter) by other salticidae objects
+// (such like MsgNetwork/PeerNetwork).
 func (self NetAddr) Copy() NetAddr {
     res := &netAddr{ inner: C.netaddr_copy(self.inner) }
     runtime.SetFinalizer(res, func(self NetAddr) { self.free() })
-- 
cgit v1.2.3