net, doc: provide context for UnserializeV1Array()

1 files changed, 6 insertions, 0 deletions

diff --git a/src/netaddress.h b/src/netaddress.h
index eb35ed3fac..d76e4d525a 100644
--- a/src/netaddress.h
+++ b/src/netaddress.h
@@ -386,6 +386,12 @@ private:
 
     /**
      * Unserialize from a pre-ADDRv2/BIP155 format from an array.
+     *
+     * This function is only called from UnserializeV1Stream() and is a wrapper
+     * for SetLegacyIPv6(); however, we keep it for symmetry with
+     * SerializeV1Array() to have pairs of ser/unser functions and to make clear
+     * that if one is altered, a corresponding reverse modification should be
+     * applied to the other.
      */
     void UnserializeV1Array(uint8_t (&arr)[V1_SERIALIZATION_SIZE])
     {