From 54388f5c79430ec2cc9d9df20b115326a06d8a65 Mon Sep 17 00:00:00 2001
From: Alex Rousskov <rousskov@measurement-factory.com>
Date: Fri, 23 Aug 2024 04:33:01 +0000
Subject: [PATCH] Maintenance: Clarify unusual IP:Intercept::LookupNat() API
 (#1894)

---
 src/ip/Intercept.h | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/src/ip/Intercept.h b/src/ip/Intercept.h
index adfac7753d7..f47b810d56b 100644
--- a/src/ip/Intercept.h
+++ b/src/ip/Intercept.h
@@ -33,6 +33,9 @@ class Intercept
     ~Intercept() {};
 
     /// perform NAT lookups for the local address of the given connection
+    /// \return true to indicate a successful lookup
+    /// \return false on errors that do not warrant listening socket closure
+    /// \throw exception on errors that warrant listening socket closure
     bool LookupNat(const Comm::Connection &);
 
     /**