Maintenance: Clarify unusual IP:Intercept::LookupNat() API

---- Cherry-picked SQUID-1005-SO_ORIGINAL_DST-loop-bag63 commit fe29ad05.
squid-cache · Aug 22, 2024 · 09679e3 · 09679e3
1 parent 46b1009
commit 09679e3
Showing 1 changed file with 3 additions and 0 deletions.
diff --git 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 &);
 
     /**