]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[2430] Update genNibbles() doc
authorMukund Sivaraman <muks@isc.org>
Mon, 17 Feb 2014 08:15:17 +0000 (13:45 +0530)
committerMukund Sivaraman <muks@isc.org>
Mon, 17 Feb 2014 08:16:33 +0000 (13:46 +0530)
src/lib/dns/master_loader.cc

index da31132c35a3a6398c04987a7664f4cbd5a37b15..5e68fedd9e41bc2095f66ab81b53ad56ce46ed47 100644 (file)
@@ -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.