From: Mukund Sivaraman <muks@isc.org>
Date: Thu, 28 Jun 2012 04:20:18 +0000 (+0530)
Subject: [2052] Fix documentation of partial_compare() for exceptions it can throw
X-Git-Tag: trac2351_base~197^2~3^2~5
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=491a0e2f9cd8a8c72bd9ae5c1650e523ca8afab9;p=thirdparty%2Fkea.git

[2052] Fix documentation of partial_compare() for exceptions it can throw
---

diff --git a/src/lib/dns/name.h b/src/lib/dns/name.h
index 4e7564f4f9..728f3a1fb3 100644
--- a/src/lib/dns/name.h
+++ b/src/lib/dns/name.h
@@ -407,7 +407,8 @@ private:
     /// <code>Name</code> and <code>other</code> and returns the result
     /// in the form of a <code>NameComparisonResult</code> object.
     ///
-    /// This method never throws an exception.
+    /// This method can throw the BadValue exception if bad label
+    /// indices are passed.
     ///
     /// \param other the right-hand operand to compare against.
     /// \param first_label the leftmost label of <code>Name</code> to