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

diff --git a/src/ip/Intercept.h b/src/ip/Intercept.h
index adfac7753d7c5c954e8515dfafef0b415efc8c10..f47b810d56baf258157e4485292f3e2305306789 100644 (file)
--- a/src/ip/Intercept.h
+++ b/src/ip/Intercept.h
@@ -33,6 +33,9 @@ public:
     ~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 &);
 
     /**