Browse Source

[2430] Update genNibbles() doc

Mukund Sivaraman 11 years ago
parent
commit
89ba2e6d39
1 changed files with 15 additions and 1 deletions
  1. 15 1
      src/lib/dns/master_loader.cc

+ 15 - 1
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.