From: Mukund Sivaraman <muks@isc.org>
Date: Mon, 17 Feb 2014 08:15:17 +0000 (+0530)
Subject: [2430] Update genNibbles() doc
X-Git-Tag: bind10-1.2.0beta1-release~50^2
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=89ba2e6d39cb06fab5a594f7cabae57802726133;p=thirdparty%2Fkea.git

[2430] Update genNibbles() doc
---

diff --git a/src/lib/dns/master_loader.cc b/src/lib/dns/master_loader.cc
index da31132c35..5e68fedd9e 100644
--- a/src/lib/dns/master_loader.cc
+++ b/src/lib/dns/master_loader.cc
@@ -587,9 +587,23 @@ namespace { // begin unnamed namespace
 /// num = 0xabcd, width = 0, uppercase = true
 /// "D.C.B.A"
 ///
+/// num = 0, width = 0
+/// "0"
+///
+/// num = 0, width = 1
+/// "0"
+///
+/// num = 0, width = 2
+/// "0."
+///
+/// num = 0, width = 3
+/// "0.0"
+///
 /// \param num The number for which the dotted nibble sequence should be
 /// generated.
-/// \param width The width of the generated string.
+/// \param width The width of the generated string. This is only
+/// meaningful when it is larger than the dotted nibble sequence
+/// representation of \c num.
 /// \param uppercase Whether to use uppercase characters in nibble
 /// sequence.
 /// \return A string containing the dotted nibble sequence.