From: Mukund Sivaraman <muks@isc.org>
Date: Thu, 5 Jul 2012 05:40:22 +0000 (+0530)
Subject: [2053] Add comment that toText(bool) variant is a helper for Name::toText()
X-Git-Tag: trac2351_base~198
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=9771dfb067dc0bf250d69bc4c07c811573d2c656;p=thirdparty%2Fkea.git

[2053] Add comment that toText(bool) variant is a helper for Name::toText()
---

diff --git a/src/lib/dns/labelsequence.h b/src/lib/dns/labelsequence.h
index 7d8827e00f..d2d9d08cae 100644
--- a/src/lib/dns/labelsequence.h
+++ b/src/lib/dns/labelsequence.h
@@ -150,6 +150,9 @@ private:
     /// returned string ends with a dot '.' if
     /// <code>omit_final_dot</code> is <code>false</code>.
     ///
+    /// This method is used as a helper for <code>Name::toText()</code>
+    /// only.
+    ///
     /// \param omit_final_dot whether to omit the trailing dot in the output.
     /// \return a string representation of the <code>LabelSequence</code>.
     std::string toText(bool omit_final_dot) const;